From 947a9653fd5efec64dffa36bf8baec3a1d366c5b Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Fri, 26 Sep 2025 12:16:48 -0700 Subject: [PATCH] [Word] (beta) Updates from CDN --- docs/docs-ref-autogen/word/toc.yml | 108 + docs/docs-ref-autogen/word/word.yml | 74 + .../word/word/word.applyquickstyleset.yml | 34 + .../word/word/word.automacro.yml | 75 + .../word/word/word.checkinversiontype.yml | 43 + .../word/word/word.compatibilitymode.yml | 63 + .../word/word.customxmlvalidationerror.yml | 4 +- .../word/word/word.document.yml | 5985 +- .../word/word/word.documentcheckinoptions.yml | 65 + ...word.documentcheckinwithversionoptions.yml | 84 + .../word.documentcheckspellingoptions.yml | 220 + ...word.documentcountnumbereditemsoptions.yml | 52 + .../word/word/word.documentencoding.yml | 1386 + .../word/word.documentendreviewoptions.yml | 84 + ...rd.documentexportasfixedformat2options.yml | 269 + ...rd.documentexportasfixedformat3options.yml | 286 + ...ord.documentexportasfixedformatoptions.yml | 250 + .../word.documentfollowhyperlinkoptions.yml | 135 + .../word/word/word.documentkind.yml | 43 + .../word/word/word.documentmergeoptions.yml | 90 + .../word/word.documentprintoutoptions.yml | 336 + .../word/word/word.documentprotectoptions.yml | 84 + .../word/word/word.documentrangeoptions.yml | 50 + .../word.documentreplywithchangesoptions.yml | 84 + ...ord.documentsendfaxoverinternetoptions.yml | 67 + .../word.documentsendforreviewoptions.yml | 84 + .../word/word/word.documenttype.yml | 43 + .../word/word/word.exportcreatebookmarks.yml | 43 + .../word/word/word.exportformat.yml | 33 + .../word/word/word.exportitem.yml | 33 + .../word/word/word.exportoptimizefor.yml | 33 + .../word/word/word.exportrange.yml | 53 + .../word/word/word.filesaveformat.yml | 266 + .../word/word/word.gotooptions.yml | 96 + .../word/word/word.htmldivision.yml | 312 + .../word/word/word.htmldivisioncollection.yml | 170 + ...mlvalidationerrorcollectionloadoptions.yml | 6 +- ...nterfaces.customxmlvalidationerrordata.yml | 4 +- ...es.customxmlvalidationerrorloadoptions.yml | 4 +- ...ces.customxmlvalidationerrorupdatedata.yml | 2 +- .../word/word.interfaces.documentdata.yml | 1895 +- .../word.interfaces.documentloadoptions.yml | 1602 +- .../word.interfaces.documentupdatedata.yml | 1266 +- ....interfaces.htmldivisioncollectiondata.yml | 27 + ...aces.htmldivisioncollectionloadoptions.yml | 124 + ...faces.htmldivisioncollectionupdatedata.yml | 27 + .../word/word.interfaces.htmldivisiondata.yml | 78 + ...ord.interfaces.htmldivisionloadoptions.yml | 113 + ...word.interfaces.htmldivisionupdatedata.yml | 78 + .../word/word.interfaces.oleformatdata.yml | 8 +- .../word.interfaces.oleformatloadoptions.yml | 8 +- ...ces.readabilitystatisticcollectiondata.yml | 29 + ...dabilitystatisticcollectionloadoptions.yml | 68 + ...adabilitystatisticcollectionupdatedata.yml | 29 + ...rd.interfaces.readabilitystatisticdata.yml | 44 + ...rfaces.readabilitystatisticloadoptions.yml | 60 + .../word/word.interfaces.websettingsdata.yml | 284 + ...word.interfaces.websettingsloadoptions.yml | 200 + .../word.interfaces.websettingsupdatedata.yml | 268 + .../word.interfaces.xmlnodecollectiondata.yml | 27 + ...nterfaces.xmlnodecollectionloadoptions.yml | 328 + ...interfaces.xmlnodecollectionupdatedata.yml | 27 + .../word/word/word.interfaces.xmlnodedata.yml | 183 + .../word.interfaces.xmlnodeloadoptions.yml | 312 + .../word.interfaces.xmlnodeupdatedata.yml | 65 + .../word/word/word.lineendingtype.yml | 63 + .../word/word/word.mergetarget.yml | 43 + .../word/word/word.oleformat.yml | 8 +- .../word/word/word.printoutitem.yml | 103 + .../word/word/word.printoutpages.yml | 43 + .../word/word/word.printoutrange.yml | 63 + .../word/word/word.protectiontype.yml | 64 + .../word/word/word.readabilitystatistic.yml | 206 + .../word.readabilitystatisticcollection.yml | 214 + .../word/word/word.removedocinfotype.yml | 214 + .../word/word/word.screensize.yml | 123 + .../word/word/word.selectnodesoptions.yml | 51 + .../word/word.selectsinglenodeoptions.yml | 51 + .../word/word/word.statistic.yml | 83 + .../word/word/word.targetbrowser.yml | 63 + .../word/word/word.textcolumncollection.yml | 22 - .../word/word/word.useformattingfrom.yml | 43 + .../word/word/word.websettings.yml | 458 + .../word/word/word.xmlnode.yml | 702 + .../word/word/word.xmlnodecollection.yml | 226 + .../word/word/word.xmlnodelevel.yml | 53 + .../word.xmlnodesetvalidationerroroptions.yml | 48 + .../word/word/word.xmlnodetype.yml | 33 + .../word/word/word.xmlvalidationstatus.yml | 33 + .../docs-ref-autogen/word_desktop_1_2/toc.yml | 8 + .../word_desktop_1_2/word.yml | 6 + .../word/word.comboboxcontentcontrol.yml | 387 + .../word/word.contentcontrol.yml | 124 + .../word/word.contentcontrollistitem.yml | 485 + .../word.contentcontrollistitemcollection.yml | 282 + .../word/word.dropdownlistcontentcontrol.yml | 391 + .../word.interfaces.contentcontroldata.yml | 40 + ...ntcontrollistitemcollectionloadoptions.yml | 89 + ....interfaces.contentcontrollistitemdata.yml | 52 + ...aces.contentcontrollistitemloadoptions.yml | 81 + ...faces.contentcontrollistitemupdatedata.yml | 52 + docs/includes/word-preview.md | 374 +- .../word/word-preview-apis.md | 2 +- generate-docs/API Coverage Report.csv | 765 +- generate-docs/GenerateDocs.sh | 25 +- .../word-desktop1.d.ts | 424 +- .../word-desktop2.d.ts | 110 +- .../word-desktop3.d.ts | 842 +- .../word-desktop4.d.ts | 18359 +++++ .../word_desktop_1_1/word-desktop1.d.ts | 267 +- .../word_desktop_1_2/word-desktop2.d.ts | 483 +- .../word_desktop_1_2/word-desktop3.d.ts | 486 +- .../word_desktop_1_2/word.d.ts | 424 +- .../api-extractor-inputs-word/word.d.ts | 59926 +++++++++------- .../script-inputs/office_preview.d.ts | 59710 ++++++++------- 115 files changed, 112787 insertions(+), 52720 deletions(-) create mode 100644 docs/docs-ref-autogen/word/word/word.applyquickstyleset.yml create mode 100644 docs/docs-ref-autogen/word/word/word.automacro.yml create mode 100644 docs/docs-ref-autogen/word/word/word.checkinversiontype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.compatibilitymode.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentcheckinoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentcheckinwithversionoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentcheckspellingoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentcountnumbereditemsoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentencoding.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentendreviewoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentexportasfixedformat2options.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentexportasfixedformat3options.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentexportasfixedformatoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentfollowhyperlinkoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentkind.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentmergeoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentprintoutoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentprotectoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentrangeoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentreplywithchangesoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentsendfaxoverinternetoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documentsendforreviewoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.documenttype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.exportcreatebookmarks.yml create mode 100644 docs/docs-ref-autogen/word/word/word.exportformat.yml create mode 100644 docs/docs-ref-autogen/word/word/word.exportitem.yml create mode 100644 docs/docs-ref-autogen/word/word/word.exportoptimizefor.yml create mode 100644 docs/docs-ref-autogen/word/word/word.exportrange.yml create mode 100644 docs/docs-ref-autogen/word/word/word.filesaveformat.yml create mode 100644 docs/docs-ref-autogen/word/word/word.gotooptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.htmldivision.yml create mode 100644 docs/docs-ref-autogen/word/word/word.htmldivisioncollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.websettingsdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.websettingsloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.websettingsupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.lineendingtype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.mergetarget.yml create mode 100644 docs/docs-ref-autogen/word/word/word.printoutitem.yml create mode 100644 docs/docs-ref-autogen/word/word/word.printoutpages.yml create mode 100644 docs/docs-ref-autogen/word/word/word.printoutrange.yml create mode 100644 docs/docs-ref-autogen/word/word/word.protectiontype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.readabilitystatistic.yml create mode 100644 docs/docs-ref-autogen/word/word/word.readabilitystatisticcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.removedocinfotype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.screensize.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectnodesoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectsinglenodeoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.statistic.yml create mode 100644 docs/docs-ref-autogen/word/word/word.targetbrowser.yml create mode 100644 docs/docs-ref-autogen/word/word/word.useformattingfrom.yml create mode 100644 docs/docs-ref-autogen/word/word/word.websettings.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlnode.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlnodecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlnodelevel.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlnodesetvalidationerroroptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlnodetype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.xmlvalidationstatus.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.comboboxcontentcontrol.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitem.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitemcollection.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.dropdownlistcontentcontrol.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemloadoptions.yml create mode 100644 generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index 8b939a3aa7..4e5e364a28 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -23,6 +23,8 @@ items: uid: word!Word.Alignment:enum - name: AnnotationState uid: word!Word.AnnotationState:enum + - name: ApplyQuickStyleSet + uid: word!Word.ApplyQuickStyleSet:enum - name: ArrowheadLength uid: word!Word.ArrowheadLength:enum - name: ArrowheadStyle @@ -31,6 +33,8 @@ items: uid: word!Word.ArrowheadWidth:enum - name: AutoFitBehavior uid: word!Word.AutoFitBehavior:enum + - name: AutoMacro + uid: word!Word.AutoMacro:enum - name: BaselineAlignment uid: word!Word.BaselineAlignment:enum - name: BevelType @@ -71,6 +75,8 @@ items: uid: word!Word.CharacterCase:enum - name: CharacterWidth uid: word!Word.CharacterWidth:enum + - name: CheckInVersionType + uid: word!Word.CheckInVersionType:enum - name: CloseBehavior uid: word!Word.CloseBehavior:enum - name: CoauthoringLockType @@ -87,6 +93,8 @@ items: uid: word!Word.CommentChangeType:enum - name: CompareTarget uid: word!Word.CompareTarget:enum + - name: CompatibilityMode + uid: word!Word.CompatibilityMode:enum - name: ConditionCode uid: word!Word.ConditionCode:enum - name: ContentControlAppearance @@ -117,8 +125,14 @@ items: uid: word!Word.DeleteCells:enum - name: DocPartInsertType uid: word!Word.DocPartInsertType:enum + - name: DocumentEncoding + uid: word!Word.DocumentEncoding:enum + - name: DocumentKind + uid: word!Word.DocumentKind:enum - name: DocumentPropertyType uid: word!Word.DocumentPropertyType:enum + - name: DocumentType + uid: word!Word.DocumentType:enum - name: DropPosition uid: word!Word.DropPosition:enum - name: EditorType @@ -133,6 +147,16 @@ items: uid: word!Word.EventSource:enum - name: EventType uid: word!Word.EventType:enum + - name: ExportCreateBookmarks + uid: word!Word.ExportCreateBookmarks:enum + - name: ExportFormat + uid: word!Word.ExportFormat:enum + - name: ExportItem + uid: word!Word.ExportItem:enum + - name: ExportOptimizeFor + uid: word!Word.ExportOptimizeFor:enum + - name: ExportRange + uid: word!Word.ExportRange:enum - name: ExtrusionColorType uid: word!Word.ExtrusionColorType:enum - name: FarEastLineBreakLanguageId @@ -145,6 +169,8 @@ items: uid: word!Word.FieldShading:enum - name: FieldType uid: word!Word.FieldType:enum + - name: FileSaveFormat + uid: word!Word.FileSaveFormat:enum - name: FillType uid: word!Word.FillType:enum - name: FlowDirection @@ -207,6 +233,8 @@ items: uid: word!Word.LightRigType:enum - name: LineDashStyle uid: word!Word.LineDashStyle:enum + - name: LineEndingType + uid: word!Word.LineEndingType:enum - name: LineFormatStyle uid: word!Word.LineFormatStyle:enum - name: LineSpacing @@ -231,6 +259,8 @@ items: uid: word!Word.ListType:enum - name: LocationRelation uid: word!Word.LocationRelation:enum + - name: MergeTarget + uid: word!Word.MergeTarget:enum - name: MovementType uid: word!Word.MovementType:enum - name: NoteItemType @@ -287,6 +317,14 @@ items: uid: word!Word.PresetTexture:enum - name: PresetThreeDimensionalFormat uid: word!Word.PresetThreeDimensionalFormat:enum + - name: PrintOutItem + uid: word!Word.PrintOutItem:enum + - name: PrintOutPages + uid: word!Word.PrintOutPages:enum + - name: PrintOutRange + uid: word!Word.PrintOutRange:enum + - name: ProtectionType + uid: word!Word.ProtectionType:enum - name: RangeLocation uid: word!Word.RangeLocation:enum - name: ReadingLayoutMargin @@ -305,6 +343,8 @@ items: uid: word!Word.RelativeSize:enum - name: RelativeVerticalPosition uid: word!Word.RelativeVerticalPosition:enum + - name: RemoveDocInfoType + uid: word!Word.RemoveDocInfoType:enum - name: RevisionsBalloonMargin uid: word!Word.RevisionsBalloonMargin:enum - name: RevisionsBalloonWidthType @@ -325,6 +365,8 @@ items: uid: word!Word.SaveBehavior:enum - name: SaveConfiguration uid: word!Word.SaveConfiguration:enum + - name: ScreenSize + uid: word!Word.ScreenSize:enum - name: SectionDirection uid: word!Word.SectionDirection:enum - name: SectionStart @@ -367,6 +409,8 @@ items: uid: word!Word.SortOrder:enum - name: SpecialPane uid: word!Word.SpecialPane:enum + - name: Statistic + uid: word!Word.Statistic:enum - name: StoryType uid: word!Word.StoryType:enum - name: StyleType @@ -387,6 +431,8 @@ items: uid: word!Word.TableFormat:enum - name: TableFormatType uid: word!Word.TableFormatType:enum + - name: TargetBrowser + uid: word!Word.TargetBrowser:enum - name: TemplateType uid: word!Word.TemplateType:enum - name: TextboxTightWrap @@ -409,6 +455,8 @@ items: uid: word!Word.Underline:enum - name: UnderlineType uid: word!Word.UnderlineType:enum + - name: UseFormattingFrom + uid: word!Word.UseFormattingFrom:enum - name: VerticalAlignment uid: word!Word.VerticalAlignment:enum - name: ViewType @@ -417,6 +465,12 @@ items: uid: word!Word.WindowState:enum - name: WindowType uid: word!Word.WindowType:enum + - name: XmlNodeLevel + uid: word!Word.XmlNodeLevel:enum + - name: XmlNodeType + uid: word!Word.XmlNodeType:enum + - name: XmlValidationStatus + uid: word!Word.XmlValidationStatus:enum - name: Annotation uid: word!Word.Annotation:class - name: AnnotationClickedEventArgs @@ -589,16 +643,48 @@ items: uid: word!Word.DatePickerContentControl:class - name: Document uid: word!Word.Document:class + - name: DocumentCheckInOptions + uid: word!Word.DocumentCheckInOptions:interface + - name: DocumentCheckInWithVersionOptions + uid: word!Word.DocumentCheckInWithVersionOptions:interface + - name: DocumentCheckSpellingOptions + uid: word!Word.DocumentCheckSpellingOptions:interface - name: DocumentCompareOptions uid: word!Word.DocumentCompareOptions:interface + - name: DocumentCountNumberedItemsOptions + uid: word!Word.DocumentCountNumberedItemsOptions:interface - name: DocumentCreated uid: word!Word.DocumentCreated:class + - name: DocumentEndReviewOptions + uid: word!Word.DocumentEndReviewOptions:interface + - name: DocumentExportAsFixedFormat2Options + uid: word!Word.DocumentExportAsFixedFormat2Options:interface + - name: DocumentExportAsFixedFormat3Options + uid: word!Word.DocumentExportAsFixedFormat3Options:interface + - name: DocumentExportAsFixedFormatOptions + uid: word!Word.DocumentExportAsFixedFormatOptions:interface + - name: DocumentFollowHyperlinkOptions + uid: word!Word.DocumentFollowHyperlinkOptions:interface - name: DocumentLibraryVersion uid: word!Word.DocumentLibraryVersion:class - name: DocumentLibraryVersionCollection uid: word!Word.DocumentLibraryVersionCollection:class + - name: DocumentMergeOptions + uid: word!Word.DocumentMergeOptions:interface + - name: DocumentPrintOutOptions + uid: word!Word.DocumentPrintOutOptions:interface - name: DocumentProperties uid: word!Word.DocumentProperties:class + - name: DocumentProtectOptions + uid: word!Word.DocumentProtectOptions:interface + - name: DocumentRangeOptions + uid: word!Word.DocumentRangeOptions:interface + - name: DocumentReplyWithChangesOptions + uid: word!Word.DocumentReplyWithChangesOptions:interface + - name: DocumentSendFaxOverInternetOptions + uid: word!Word.DocumentSendFaxOverInternetOptions:interface + - name: DocumentSendForReviewOptions + uid: word!Word.DocumentSendForReviewOptions:interface - name: DropCap uid: word!Word.DropCap:class - name: DropDownListContentControl @@ -625,12 +711,18 @@ items: uid: word!Word.GetTextOptions:interface - name: GlowFormat uid: word!Word.GlowFormat:class + - name: GoToOptions + uid: word!Word.GoToOptions:interface - name: GroupContentControl uid: word!Word.GroupContentControl:class - name: HeadingStyle uid: word!Word.HeadingStyle:class - name: HeadingStyleCollection uid: word!Word.HeadingStyleCollection:class + - name: HtmlDivision + uid: word!Word.HtmlDivision:class + - name: HtmlDivisionCollection + uid: word!Word.HtmlDivisionCollection:class - name: Hyperlink uid: word!Word.Hyperlink:class - name: HyperlinkAddOptions @@ -723,6 +815,10 @@ items: uid: word!Word.RangeCollection:class - name: RangeScopedCollection uid: word!Word.RangeScopedCollection:class + - name: ReadabilityStatistic + uid: word!Word.ReadabilityStatistic:class + - name: ReadabilityStatisticCollection + uid: word!Word.ReadabilityStatisticCollection:class - name: ReflectionFormat uid: word!Word.ReflectionFormat:class - name: RepeatingSectionContentControl @@ -777,6 +873,10 @@ items: uid: word!Word.SelectionNextOptions:interface - name: SelectionPreviousOptions uid: word!Word.SelectionPreviousOptions:interface + - name: SelectNodesOptions + uid: word!Word.SelectNodesOptions:interface + - name: SelectSingleNodeOptions + uid: word!Word.SelectSingleNodeOptions:interface - name: Setting uid: word!Word.Setting:class - name: SettingCollection @@ -887,6 +987,8 @@ items: uid: word!Word.TrackedChangeCollection:class - name: View uid: word!Word.View:class + - name: WebSettings + uid: word!Word.WebSettings:class - name: Window uid: word!Word.Window:class - name: WindowCloseOptions @@ -899,6 +1001,12 @@ items: uid: word!Word.WindowScrollOptions:interface - name: XmlMapping uid: word!Word.XmlMapping:class + - name: XmlNode + uid: word!Word.XmlNode:class + - name: XmlNodeCollection + uid: word!Word.XmlNodeCollection:class + - name: XmlNodeSetValidationErrorOptions + uid: word!Word.XmlNodeSetValidationErrorOptions:interface - name: XmlSetMappingOptions uid: word!Word.XmlSetMappingOptions:interface - name: Common APIs diff --git a/docs/docs-ref-autogen/word/word.yml b/docs/docs-ref-autogen/word/word.yml index 007b6ca362..b20f6ca20c 100644 --- a/docs/docs-ref-autogen/word/word.yml +++ b/docs/docs-ref-autogen/word/word.yml @@ -6,10 +6,12 @@ summary: '' enums: - word!Word.Alignment:enum - word!Word.AnnotationState:enum + - word!Word.ApplyQuickStyleSet:enum - word!Word.ArrowheadLength:enum - word!Word.ArrowheadStyle:enum - word!Word.ArrowheadWidth:enum - word!Word.AutoFitBehavior:enum + - word!Word.AutoMacro:enum - word!Word.BaselineAlignment:enum - word!Word.BevelType:enum - word!Word.BodyType:enum @@ -30,6 +32,7 @@ enums: - word!Word.ChangeTrackingVersion:enum - word!Word.CharacterCase:enum - word!Word.CharacterWidth:enum + - word!Word.CheckInVersionType:enum - word!Word.CloseBehavior:enum - word!Word.CoauthoringLockType:enum - word!Word.CollapseDirection:enum @@ -38,6 +41,7 @@ enums: - word!Word.ColumnWidth:enum - word!Word.CommentChangeType:enum - word!Word.CompareTarget:enum + - word!Word.CompatibilityMode:enum - word!Word.ConditionCode:enum - word!Word.ContentControlAppearance:enum - word!Word.ContentControlDateStorageFormat:enum @@ -53,7 +57,10 @@ enums: - word!Word.DefaultTableBehavior:enum - word!Word.DeleteCells:enum - word!Word.DocPartInsertType:enum + - word!Word.DocumentEncoding:enum + - word!Word.DocumentKind:enum - word!Word.DocumentPropertyType:enum + - word!Word.DocumentType:enum - word!Word.DropPosition:enum - word!Word.EditorType:enum - word!Word.EmphasisMark:enum @@ -61,12 +68,18 @@ enums: - word!Word.ErrorCodes:enum - word!Word.EventSource:enum - word!Word.EventType:enum + - word!Word.ExportCreateBookmarks:enum + - word!Word.ExportFormat:enum + - word!Word.ExportItem:enum + - word!Word.ExportOptimizeFor:enum + - word!Word.ExportRange:enum - word!Word.ExtrusionColorType:enum - word!Word.FarEastLineBreakLanguageId:enum - word!Word.FarEastLineBreakLevel:enum - word!Word.FieldKind:enum - word!Word.FieldShading:enum - word!Word.FieldType:enum + - word!Word.FileSaveFormat:enum - word!Word.FillType:enum - word!Word.FlowDirection:enum - word!Word.FontBias:enum @@ -98,6 +111,7 @@ enums: - word!Word.Ligature:enum - word!Word.LightRigType:enum - word!Word.LineDashStyle:enum + - word!Word.LineEndingType:enum - word!Word.LineFormatStyle:enum - word!Word.LineSpacing:enum - word!Word.LineWidth:enum @@ -110,6 +124,7 @@ enums: - word!Word.ListTemplateGalleryType:enum - word!Word.ListType:enum - word!Word.LocationRelation:enum + - word!Word.MergeTarget:enum - word!Word.MovementType:enum - word!Word.NoteItemType:enum - word!Word.NoteNumberStyle:enum @@ -138,6 +153,10 @@ enums: - word!Word.PresetMaterial:enum - word!Word.PresetTexture:enum - word!Word.PresetThreeDimensionalFormat:enum + - word!Word.PrintOutItem:enum + - word!Word.PrintOutPages:enum + - word!Word.PrintOutRange:enum + - word!Word.ProtectionType:enum - word!Word.RangeLocation:enum - word!Word.ReadingLayoutMargin:enum - word!Word.ReadingOrder:enum @@ -147,6 +166,7 @@ enums: - word!Word.RelativeHorizontalPosition:enum - word!Word.RelativeSize:enum - word!Word.RelativeVerticalPosition:enum + - word!Word.RemoveDocInfoType:enum - word!Word.RevisionsBalloonMargin:enum - word!Word.RevisionsBalloonWidthType:enum - word!Word.RevisionsMarkup:enum @@ -157,6 +177,7 @@ enums: - word!Word.RulerStyle:enum - word!Word.SaveBehavior:enum - word!Word.SaveConfiguration:enum + - word!Word.ScreenSize:enum - word!Word.SectionDirection:enum - word!Word.SectionStart:enum - word!Word.SeekView:enum @@ -178,6 +199,7 @@ enums: - word!Word.SortFieldType:enum - word!Word.SortOrder:enum - word!Word.SpecialPane:enum + - word!Word.Statistic:enum - word!Word.StoryType:enum - word!Word.StyleType:enum - word!Word.StylisticSet:enum @@ -188,6 +210,7 @@ enums: - word!Word.TableFieldSeparator:enum - word!Word.TableFormat:enum - word!Word.TableFormatType:enum + - word!Word.TargetBrowser:enum - word!Word.TemplateType:enum - word!Word.TextboxTightWrap:enum - word!Word.TextOrientation:enum @@ -199,10 +222,14 @@ enums: - word!Word.TwoLinesInOneType:enum - word!Word.Underline:enum - word!Word.UnderlineType:enum + - word!Word.UseFormattingFrom:enum - word!Word.VerticalAlignment:enum - word!Word.ViewType:enum - word!Word.WindowState:enum - word!Word.WindowType:enum + - word!Word.XmlNodeLevel:enum + - word!Word.XmlNodeType:enum + - word!Word.XmlValidationStatus:enum classes: - word!Word.Annotation:class - word!Word.AnnotationCollection:class @@ -283,6 +310,8 @@ classes: - word!Word.GroupContentControl:class - word!Word.HeadingStyle:class - word!Word.HeadingStyleCollection:class + - word!Word.HtmlDivision:class + - word!Word.HtmlDivisionCollection:class - word!Word.Hyperlink:class - word!Word.HyperlinkCollection:class - word!Word.Index:class @@ -317,6 +346,8 @@ classes: - word!Word.Range:class - word!Word.RangeCollection:class - word!Word.RangeScopedCollection:class + - word!Word.ReadabilityStatistic:class + - word!Word.ReadabilityStatisticCollection:class - word!Word.ReflectionFormat:class - word!Word.RepeatingSectionContentControl:class - word!Word.RepeatingSectionItem:class @@ -374,9 +405,12 @@ classes: - word!Word.TrackedChange:class - word!Word.TrackedChangeCollection:class - word!Word.View:class + - word!Word.WebSettings:class - word!Word.Window:class - word!Word.WindowCollection:class - word!Word.XmlMapping:class + - word!Word.XmlNode:class + - word!Word.XmlNodeCollection:class interfaces: - word!Word.AnnotationClickedEventArgs:interface - word!Word.AnnotationHoveredEventArgs:interface @@ -404,8 +438,25 @@ interfaces: - word!Word.CustomXmlInsertNodeBeforeOptions:interface - word!Word.CustomXmlInsertSubtreeBeforeOptions:interface - word!Word.CustomXmlReplaceChildNodeOptions:interface + - word!Word.DocumentCheckInOptions:interface + - word!Word.DocumentCheckInWithVersionOptions:interface + - word!Word.DocumentCheckSpellingOptions:interface - word!Word.DocumentCompareOptions:interface + - word!Word.DocumentCountNumberedItemsOptions:interface + - word!Word.DocumentEndReviewOptions:interface + - word!Word.DocumentExportAsFixedFormat2Options:interface + - word!Word.DocumentExportAsFixedFormat3Options:interface + - word!Word.DocumentExportAsFixedFormatOptions:interface + - word!Word.DocumentFollowHyperlinkOptions:interface + - word!Word.DocumentMergeOptions:interface + - word!Word.DocumentPrintOutOptions:interface + - word!Word.DocumentProtectOptions:interface + - word!Word.DocumentRangeOptions:interface + - word!Word.DocumentReplyWithChangesOptions:interface + - word!Word.DocumentSendFaxOverInternetOptions:interface + - word!Word.DocumentSendForReviewOptions:interface - word!Word.GetTextOptions:interface + - word!Word.GoToOptions:interface - word!Word.HyperlinkAddOptions:interface - word!Word.IndexAddOptions:interface - word!Word.IndexMarkAllEntriesOptions:interface @@ -618,6 +669,12 @@ interfaces: - word!Word.Interfaces.HeadingStyleData:interface - word!Word.Interfaces.HeadingStyleLoadOptions:interface - word!Word.Interfaces.HeadingStyleUpdateData:interface + - word!Word.Interfaces.HtmlDivisionCollectionData:interface + - word!Word.Interfaces.HtmlDivisionCollectionLoadOptions:interface + - word!Word.Interfaces.HtmlDivisionCollectionUpdateData:interface + - word!Word.Interfaces.HtmlDivisionData:interface + - word!Word.Interfaces.HtmlDivisionLoadOptions:interface + - word!Word.Interfaces.HtmlDivisionUpdateData:interface - word!Word.Interfaces.HyperlinkCollectionData:interface - word!Word.Interfaces.HyperlinkCollectionLoadOptions:interface - word!Word.Interfaces.HyperlinkCollectionUpdateData:interface @@ -714,6 +771,11 @@ interfaces: - word!Word.Interfaces.RangeScopedCollectionLoadOptions:interface - word!Word.Interfaces.RangeScopedCollectionUpdateData:interface - word!Word.Interfaces.RangeUpdateData:interface + - word!Word.Interfaces.ReadabilityStatisticCollectionData:interface + - word!Word.Interfaces.ReadabilityStatisticCollectionLoadOptions:interface + - word!Word.Interfaces.ReadabilityStatisticCollectionUpdateData:interface + - word!Word.Interfaces.ReadabilityStatisticData:interface + - word!Word.Interfaces.ReadabilityStatisticLoadOptions:interface - word!Word.Interfaces.ReflectionFormatData:interface - word!Word.Interfaces.ReflectionFormatLoadOptions:interface - word!Word.Interfaces.ReflectionFormatUpdateData:interface @@ -877,6 +939,9 @@ interfaces: - word!Word.Interfaces.ViewData:interface - word!Word.Interfaces.ViewLoadOptions:interface - word!Word.Interfaces.ViewUpdateData:interface + - word!Word.Interfaces.WebSettingsData:interface + - word!Word.Interfaces.WebSettingsLoadOptions:interface + - word!Word.Interfaces.WebSettingsUpdateData:interface - word!Word.Interfaces.WindowCollectionData:interface - word!Word.Interfaces.WindowCollectionLoadOptions:interface - word!Word.Interfaces.WindowCollectionUpdateData:interface @@ -886,6 +951,12 @@ interfaces: - word!Word.Interfaces.XmlMappingData:interface - word!Word.Interfaces.XmlMappingLoadOptions:interface - word!Word.Interfaces.XmlMappingUpdateData:interface + - word!Word.Interfaces.XmlNodeCollectionData:interface + - word!Word.Interfaces.XmlNodeCollectionLoadOptions:interface + - word!Word.Interfaces.XmlNodeCollectionUpdateData:interface + - word!Word.Interfaces.XmlNodeData:interface + - word!Word.Interfaces.XmlNodeLoadOptions:interface + - word!Word.Interfaces.XmlNodeUpdateData:interface - word!Word.ListFormatCountNumberedItemsOptions:interface - word!Word.ListTemplateApplyOptions:interface - word!Word.ListTemplateCollectionAddOptions:interface @@ -905,6 +976,8 @@ interfaces: - word!Word.SelectionMoveUpDownOptions:interface - word!Word.SelectionNextOptions:interface - word!Word.SelectionPreviousOptions:interface + - word!Word.SelectNodesOptions:interface + - word!Word.SelectSingleNodeOptions:interface - word!Word.TableAutoFormatOptions:interface - word!Word.TableCellCollectionSplitOptions:interface - word!Word.TableCellFormulaOptions:interface @@ -920,6 +993,7 @@ interfaces: - word!Word.WindowCloseOptions:interface - word!Word.WindowPageScrollOptions:interface - word!Word.WindowScrollOptions:interface + - word!Word.XmlNodeSetValidationErrorOptions:interface - word!Word.XmlSetMappingOptions:interface functions: - name: Word.run(objects, batch) diff --git a/docs/docs-ref-autogen/word/word/word.applyquickstyleset.yml b/docs/docs-ref-autogen/word/word/word.applyquickstyleset.yml new file mode 100644 index 0000000000..bcd2290015 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.applyquickstyleset.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: Word.ApplyQuickStyleSet +uid: word!Word.ApplyQuickStyleSet:enum +package: word! +fullName: Word.ApplyQuickStyleSet +summary: Specifies which Quick Style set to apply to the document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: sessionStart + uid: word!Word.ApplyQuickStyleSet.sessionStart:member + package: word! + summary: >- + Resets the Quick Style to the style set in use when the document was + opened. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SessionStart"' + - name: template + uid: word!Word.ApplyQuickStyleSet.template:member + package: word! + summary: >- + Resets the Quick Style to the style set from the template, if any. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Template"' diff --git a/docs/docs-ref-autogen/word/word/word.automacro.yml b/docs/docs-ref-autogen/word/word/word.automacro.yml new file mode 100644 index 0000000000..006a974520 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.automacro.yml @@ -0,0 +1,75 @@ +### YamlMime:TSEnum +name: Word.AutoMacro +uid: word!Word.AutoMacro:enum +package: word! +fullName: Word.AutoMacro +summary: Indicates the auto macros that can run automatically in Word. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: close + uid: word!Word.AutoMacro.close:member + package: word! + summary: >- + Indicates that the macro runs automatically when the document is closed. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Close"' + - name: exit + uid: word!Word.AutoMacro.exit:member + package: word! + summary: >- + Indicates that the macro runs automatically when the document is saved. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Exit"' + - name: new + uid: word!Word.AutoMacro.new:member + package: word! + summary: >- + Indicates that the macro runs automatically when a new document is + created. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"New"' + - name: open + uid: word!Word.AutoMacro.open:member + package: word! + summary: >- + Indicates that the macro runs automatically when the document is opened. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Open"' + - name: startWord + uid: word!Word.AutoMacro.startWord:member + package: word! + summary: >- + Indicates that the macro runs automatically when Word starts. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"StartWord"' + - name: sync + uid: word!Word.AutoMacro.sync:member + package: word! + summary: >- + Indicates that the macro runs automatically when the document is + synchronized. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Sync"' diff --git a/docs/docs-ref-autogen/word/word/word.checkinversiontype.yml b/docs/docs-ref-autogen/word/word/word.checkinversiontype.yml new file mode 100644 index 0000000000..887a2a973e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.checkinversiontype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.CheckInVersionType +uid: word!Word.CheckInVersionType:enum +package: word! +fullName: Word.CheckInVersionType +summary: Specifies the version type for document check-in operations. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: major + uid: word!Word.CheckInVersionType.major:member + package: word! + summary: >- + Represents a major version check-in. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Major"' + - name: minor + uid: word!Word.CheckInVersionType.minor:member + package: word! + summary: >- + Represents a minor version check-in. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Minor"' + - name: overwrite + uid: word!Word.CheckInVersionType.overwrite:member + package: word! + summary: >- + Represents an overwrite version check-in. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Overwrite"' diff --git a/docs/docs-ref-autogen/word/word/word.compatibilitymode.yml b/docs/docs-ref-autogen/word/word/word.compatibilitymode.yml new file mode 100644 index 0000000000..3df1063b32 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.compatibilitymode.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Word.CompatibilityMode +uid: word!Word.CompatibilityMode:enum +package: word! +fullName: Word.CompatibilityMode +summary: Specifies the compatibility mode that Word uses when opening the document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: current + uid: word!Word.CompatibilityMode.current:member + package: word! + summary: >- + Current Word version compatibility mode. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Current"' + - name: word2003 + uid: word!Word.CompatibilityMode.word2003:member + package: word! + summary: >- + Word 2003 compatibility mode. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Word2003"' + - name: word2007 + uid: word!Word.CompatibilityMode.word2007:member + package: word! + summary: >- + Word 2007 compatibility mode. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Word2007"' + - name: word2010 + uid: word!Word.CompatibilityMode.word2010:member + package: word! + summary: >- + Word 2010 compatibility mode. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Word2010"' + - name: word2013 + uid: word!Word.CompatibilityMode.word2013:member + package: word! + summary: >- + Word 2013 compatibility mode. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Word2013"' diff --git a/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml b/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml index f995576d44..57124e06c6 100644 --- a/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml +++ b/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml @@ -52,7 +52,7 @@ properties: package: word! fullName: name summary: >- - Gets the name of the error in the `CustomXmlValidationError` object.If no + Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` remarks: >- \[ [API set: WordApi BETA (PREVIEW @@ -70,7 +70,7 @@ properties: fullName: node summary: >- Gets the node associated with this `CustomXmlValidationError` object, if - any exist.If no nodes exist, the property returns `Nothing`. + any exist. If no nodes exist, the property returns `Nothing`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index eaa6cc4332..383eea9e7f 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -43,6 +43,36 @@ isPreview: false isDeprecated: false type: class properties: + - name: activeTheme + uid: word!Word.Document#activeTheme:member + package: word! + fullName: activeTheme + summary: Gets the name of the active theme and formatting options. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly activeTheme: string;' + return: + type: string + - name: activeThemeDisplayName + uid: word!Word.Document#activeThemeDisplayName:member + package: word! + fullName: activeThemeDisplayName + summary: Gets the display name of the active theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly activeThemeDisplayName: string;' + return: + type: string - name: activeWindow uid: word!Word.Document#activeWindow:member package: word! @@ -115,6 +145,125 @@ properties: content: 'readonly activeWindow: Word.Window;' return: type: + - name: areFilePropertiesPasswordEncrypted + uid: word!Word.Document#areFilePropertiesPasswordEncrypted:member + package: word! + fullName: areFilePropertiesPasswordEncrypted + summary: >- + Gets whether Word encrypts file properties for password-protected + documents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly areFilePropertiesPasswordEncrypted: boolean;' + return: + type: boolean + - name: areGrammaticalErrorsShown + uid: word!Word.Document#areGrammaticalErrorsShown:member + package: word! + fullName: areGrammaticalErrorsShown + summary: >- + Specifies whether grammatical errors are marked by a wavy green line in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areGrammaticalErrorsShown: boolean;' + return: + type: boolean + - name: areMathDefaultsUsed + uid: word!Word.Document#areMathDefaultsUsed:member + package: word! + fullName: areMathDefaultsUsed + summary: >- + Specifies whether to use the default math settings when creating new + equations. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areMathDefaultsUsed: boolean;' + return: + type: boolean + - name: areNewerFeaturesDisabled + uid: word!Word.Document#areNewerFeaturesDisabled:member + package: word! + fullName: areNewerFeaturesDisabled + summary: >- + Specifies whether to disable features introduced after a specified + version. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areNewerFeaturesDisabled: boolean;' + return: + type: boolean + - name: areSpellingErrorsShown + uid: word!Word.Document#areSpellingErrorsShown:member + package: word! + fullName: areSpellingErrorsShown + summary: >- + Specifies whether Microsoft Word underlines spelling errors in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areSpellingErrorsShown: boolean;' + return: + type: boolean + - name: areStylesUpdatedOnOpen + uid: word!Word.Document#areStylesUpdatedOnOpen:member + package: word! + fullName: areStylesUpdatedOnOpen + summary: >- + Specifies whether the styles in this document are updated to match the + styles in the attached template each time the document is opened. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areStylesUpdatedOnOpen: boolean;' + return: + type: boolean + - name: areTrueTypeFontsEmbedded + uid: word!Word.Document#areTrueTypeFontsEmbedded:member + package: word! + fullName: areTrueTypeFontsEmbedded + summary: >- + Specifies whether Microsoft Word embeds TrueType fonts in the document + when it's saved. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areTrueTypeFontsEmbedded: boolean;' + return: + type: boolean - name: attachedTemplate uid: word!Word.Document#attachedTemplate:member package: word! @@ -162,6 +311,23 @@ properties: content: 'autoSaveOn: boolean;' return: type: boolean + - name: background + uid: word!Word.Document#background:member + package: word! + fullName: background + summary: >- + Gets a `Shape` object that represents the background image for the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly background: Word.Shape;' + return: + type: - name: bibliography uid: word!Word.Document#bibliography:member package: word! @@ -213,6 +379,23 @@ properties: content: 'readonly bookmarks: Word.BookmarkCollection;' return: type: + - name: builtInDocumentProperties + uid: word!Word.Document#builtInDocumentProperties:member + package: word! + fullName: builtInDocumentProperties + summary: >- + Gets a `DocumentProperties` object that represents all the built-in + document properties for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly builtInDocumentProperties: Word.DocumentProperties;' + return: + type: - name: changeTrackingMode uid: word!Word.Document#changeTrackingMode:member package: word! @@ -260,6 +443,23 @@ properties: type: >- | "Off" | "TrackAll" | "TrackMineOnly" + - name: characters + uid: word!Word.Document#characters:member + package: word! + fullName: characters + summary: >- + Gets the `RangeScopedCollection` object that represents all the characters + in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly characters: Word.RangeScopedCollection;' + return: + type: - name: coauthoring uid: word!Word.Document#coauthoring:member package: word! @@ -275,6 +475,57 @@ properties: content: 'readonly coauthoring: Word.Coauthoring;' return: type: + - name: codeName + uid: word!Word.Document#codeName:member + package: word! + fullName: codeName + summary: Gets the code name for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly codeName: string;' + return: + type: string + - name: comments + uid: word!Word.Document#comments:member + package: word! + fullName: comments + summary: >- + Gets a `CommentCollection` object that represents all the comments in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly comments: Word.CommentCollection;' + return: + type: + - name: compatibilityMode + uid: word!Word.Document#compatibilityMode:member + package: word! + fullName: compatibilityMode + summary: Gets the compatibility mode that Word uses when opening the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | + "Word2007" | "Word2010" | "Word2013" | "Current"; + return: + type: >- + | "Word2003" | + "Word2007" | "Word2010" | "Word2013" | "Current" - name: consecutiveHyphensLimit uid: word!Word.Document#consecutiveHyphensLimit:member package: word! @@ -292,6 +543,21 @@ properties: content: 'consecutiveHyphensLimit: number;' return: type: number + - name: content + uid: word!Word.Document#content:member + package: word! + fullName: content + summary: Gets a `Range` object that represents the main document story. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly content: Word.Range;' + return: + type: - name: contentControls uid: word!Word.Document#contentControls:member package: word! @@ -325,6 +591,38 @@ properties: content: 'context: RequestContext;' return: type: + - name: currentRsid + uid: word!Word.Document#currentRsid:member + package: word! + fullName: currentRsid + summary: Gets a random number that Word assigns to changes in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly currentRsid: number;' + return: + type: number + - name: customDocumentProperties + uid: word!Word.Document#customDocumentProperties:member + package: word! + fullName: customDocumentProperties + summary: >- + Gets a `DocumentProperties` collection that represents all the custom + document properties for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly customDocumentProperties: Word.DocumentProperties;' + return: + type: - name: customXmlParts uid: word!Word.Document#customXmlParts:member package: word! @@ -340,14 +638,13 @@ properties: content: 'readonly customXmlParts: Word.CustomXmlPartCollection;' return: type: - - name: documentLibraryVersions - uid: word!Word.Document#documentLibraryVersions:member + - name: defaultTabStop + uid: word!Word.Document#defaultTabStop:member package: word! - fullName: documentLibraryVersions + fullName: defaultTabStop summary: >- - Returns a `DocumentLibraryVersionCollection` object that represents the - collection of versions of a shared document that has versioning enabled - and that's stored in a document library on a server. + Specifies the interval (in points) between the default tab stops in the + document. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -355,16 +652,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;' + content: 'defaultTabStop: number;' return: - type: - - name: frames - uid: word!Word.Document#frames:member + type: number + - name: defaultTargetFrame + uid: word!Word.Document#defaultTargetFrame:member package: word! - fullName: frames - summary: >- - Returns a `FrameCollection` object that represents all the frames in the - document. + fullName: defaultTargetFrame + summary: Specifies the browser frame for displaying a webpage via hyperlink. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -372,16 +667,17 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly frames: Word.FrameCollection;' + content: 'defaultTargetFrame: string;' return: - type: - - name: hyperlinks - uid: word!Word.Document#hyperlinks:member + type: string + - name: documentLibraryVersions + uid: word!Word.Document#documentLibraryVersions:member package: word! - fullName: hyperlinks + fullName: documentLibraryVersions summary: >- - Returns a `HyperlinkCollection` object that represents all the hyperlinks - in the document. + Returns a `DocumentLibraryVersionCollection` object that represents the + collection of versions of a shared document that has versioning enabled + and that's stored in a document library on a server. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -389,14 +685,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly hyperlinks: Word.HyperlinkCollection;' + content: 'readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;' return: - type: - - name: hyphenateCaps - uid: word!Word.Document#hyphenateCaps:member + type: + - name: doNotEmbedSystemFonts + uid: word!Word.Document#doNotEmbedSystemFonts:member package: word! - fullName: hyphenateCaps - summary: Specifies whether words in all capital letters can be hyphenated. + fullName: doNotEmbedSystemFonts + summary: Specifies whether Word should not embed common system fonts. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -404,16 +700,16 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'hyphenateCaps: boolean;' + content: 'doNotEmbedSystemFonts: boolean;' return: type: boolean - - name: indexes - uid: word!Word.Document#indexes:member + - name: encryptionProvider + uid: word!Word.Document#encryptionProvider:member package: word! - fullName: indexes + fullName: encryptionProvider summary: >- - Returns an `IndexCollection` object that represents all the indexes in the - document. + Specifies the name of the algorithm encryption provider that Microsoft + Word uses when encrypting documents. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -421,16 +717,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly indexes: Word.IndexCollection;' + content: 'encryptionProvider: string;' return: - type: - - name: languageDetected - uid: word!Word.Document#languageDetected:member + type: string + - name: farEastLineBreakLanguage + uid: word!Word.Document#farEastLineBreakLanguage:member package: word! - fullName: languageDetected - summary: >- - Specifies whether Microsoft Word has detected the language of the document - text. + fullName: farEastLineBreakLanguage + summary: Specifies the East Asian language used for line breaking. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -438,16 +732,18 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'languageDetected: boolean;' + content: >- + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; return: - type: boolean - - name: listTemplates - uid: word!Word.Document#listTemplates:member + type: >- + | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese" + - name: farEastLineBreakLevel + uid: word!Word.Document#farEastLineBreakLevel:member package: word! - fullName: listTemplates - summary: >- - Returns a `ListTemplateCollection` object that represents all the list - templates in the document. + fullName: farEastLineBreakLevel + summary: Specifies the line break control level. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -455,14 +751,20 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly listTemplates: Word.ListTemplateCollection;' + content: >- + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" + | "Custom"; return: - type: - - name: pageSetup - uid: word!Word.Document#pageSetup:member + type: >- + | "Normal" | + "Strict" | "Custom" + - name: fields + uid: word!Word.Document#fields:member package: word! - fullName: pageSetup - summary: Returns a `PageSetup` object that's associated with the document. + fullName: fields + summary: >- + Gets a `FieldCollection` object that represents all the fields in the + document. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -470,101 +772,133 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly pageSetup: Word.PageSetup;' + content: 'readonly fields: Word.FieldCollection;' return: - type: - - name: properties - uid: word!Word.Document#properties:member + type: + - name: formattingIsNextLevelShown + uid: word!Word.Document#formattingIsNextLevelShown:member package: word! - fullName: properties - summary: Gets the properties of the document. + fullName: formattingIsNextLevelShown + summary: >- + Specifies whether Word shows the next heading level when the previous is + used. remarks: >- - \[ [API set: WordApi - 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml - + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - await Word.run(async (context) => { - const builtInProperties: Word.DocumentProperties = context.document.properties; - builtInProperties.load("*"); // Let's get all! + isPreview: true + isDeprecated: false + syntax: + content: 'formattingIsNextLevelShown: boolean;' + return: + type: boolean + - name: formattingIsUserStyleNameShown + uid: word!Word.Document#formattingIsUserStyleNameShown:member + package: word! + fullName: formattingIsUserStyleNameShown + summary: Specifies whether to show user-defined styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - await context.sync(); - console.log(JSON.stringify(builtInProperties, null, 4)); - }); + isPreview: true + isDeprecated: false + syntax: + content: 'formattingIsUserStyleNameShown: boolean;' + return: + type: boolean + - name: frames + uid: word!Word.Document#frames:member + package: word! + fullName: frames + summary: >- + Returns a `FrameCollection` object that represents all the frames in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - ``` + isPreview: true + isDeprecated: false + syntax: + content: 'readonly frames: Word.FrameCollection;' + return: + type: + - name: fullName + uid: word!Word.Document#fullName:member + package: word! + fullName: fullName + summary: Gets the name of a document, including the path. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'readonly properties: Word.DocumentProperties;' + content: 'readonly fullName: string;' return: - type: - - name: revisions - uid: word!Word.Document#revisions:member + type: string + - name: grammaticalErrors + uid: word!Word.Document#grammaticalErrors:member package: word! - fullName: revisions + fullName: grammaticalErrors summary: >- - Gets the collection of revisions that represents the tracked changes in - the document. + Gets a `RangeCollection` object that represents the sentences that failed + the grammar check in the document. remarks: >- \[ [API set: WordApi BETA (PREVIEW - ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) - \] + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] isPreview: true isDeprecated: false syntax: - content: 'readonly revisions: Word.RevisionCollection;' + content: 'readonly grammaticalErrors: Word.RangeCollection;' return: - type: - - name: saved - uid: word!Word.Document#saved:member + type: + - name: gridDistanceHorizontal + uid: word!Word.Document#gridDistanceHorizontal:member package: word! - fullName: saved + fullName: gridDistanceHorizontal summary: >- - 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. + Specifies the horizontal space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'readonly saved: boolean;' + content: 'gridDistanceHorizontal: number;' return: - type: boolean - - name: sections - uid: word!Word.Document#sections:member + type: number + - name: gridDistanceVertical + uid: word!Word.Document#gridDistanceVertical:member package: word! - fullName: sections - summary: Gets the collection of section objects in the document. + fullName: gridDistanceVertical + summary: >- + Specifies the vertical space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'readonly sections: Word.SectionCollection;' + content: 'gridDistanceVertical: number;' return: - type: - - name: selection - uid: word!Word.Document#selection:member + type: number + - name: gridIsOriginFromMargin + uid: word!Word.Document#gridIsOriginFromMargin:member package: word! - fullName: selection + fullName: gridIsOriginFromMargin summary: >- - Returns a `Selection` object that represents the current selection in the - document. + Specifies whether the character grid starts from the upper-left corner of + the page. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -572,60 +906,46 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly selection: Word.Selection;' + content: 'gridIsOriginFromMargin: boolean;' return: - type: - - name: settings - uid: word!Word.Document#settings:member + type: boolean + - name: gridOriginHorizontal + uid: word!Word.Document#gridOriginHorizontal:member package: word! - fullName: settings - summary: Gets the add-in's settings in the document. + fullName: gridOriginHorizontal + summary: Specifies the horizontal origin point for the invisible grid. remarks: >- - \[ [API set: WordApi - 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml - - - // Gets all custom settings this add-in set on this document. - - await Word.run(async (context) => { - const settings: Word.SettingCollection = context.document.settings; - settings.load("items"); - await context.sync(); - - if (settings.items.length == 0) { - console.log("There are no settings."); - } else { - console.log("All settings:"); - for (let i = 0; i < settings.items.length; i++) { - console.log(settings.items[i]); - } - } - }); + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - ``` + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginHorizontal: number;' + return: + type: number + - name: gridOriginVertical + uid: word!Word.Document#gridOriginVertical:member + package: word! + fullName: gridOriginVertical + summary: Specifies the vertical origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'readonly settings: Word.SettingCollection;' + content: 'gridOriginVertical: number;' return: - type: - - name: tableOfAuthoritiesCategories - uid: word!Word.Document#tableOfAuthoritiesCategories:member + type: number + - name: gridSpaceBetweenHorizontalLines + uid: word!Word.Document#gridSpaceBetweenHorizontalLines:member package: word! - fullName: tableOfAuthoritiesCategories + fullName: gridSpaceBetweenHorizontalLines summary: >- - Returns a `TableOfAuthoritiesCategoryCollection` object that represents - the available table of authorities categories in the document. + Specifies the interval for horizontal character gridlines in print layout + view. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -633,18 +953,16 @@ properties: isPreview: true isDeprecated: false syntax: - content: >- - readonly tableOfAuthoritiesCategories: - Word.TableOfAuthoritiesCategoryCollection; + content: 'gridSpaceBetweenHorizontalLines: number;' return: - type: - - name: tablesOfAuthorities - uid: word!Word.Document#tablesOfAuthorities:member + type: number + - name: gridSpaceBetweenVerticalLines + uid: word!Word.Document#gridSpaceBetweenVerticalLines:member package: word! - fullName: tablesOfAuthorities + fullName: gridSpaceBetweenVerticalLines summary: >- - Returns a `TableOfAuthoritiesCollection` object that represents all the - tables of authorities in the document. + Specifies the interval for vertical character gridlines in print layout + view. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -652,16 +970,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;' + content: 'gridSpaceBetweenVerticalLines: number;' return: - type: - - name: tablesOfContents - uid: word!Word.Document#tablesOfContents:member + type: number + - name: hasPassword + uid: word!Word.Document#hasPassword:member package: word! - fullName: tablesOfContents - summary: >- - Returns a `TableOfContentsCollection` object that represents all the - tables of contents in the document. + fullName: hasPassword + summary: Gets whether a password is required to open the document. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -669,16 +985,16 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly tablesOfContents: Word.TableOfContentsCollection;' + content: 'readonly hasPassword: boolean;' return: - type: - - name: tablesOfFigures - uid: word!Word.Document#tablesOfFigures:member + type: boolean + - name: hasVbProject + uid: word!Word.Document#hasVbProject:member package: word! - fullName: tablesOfFigures + fullName: hasVbProject summary: >- - Returns a `TableOfFiguresCollection` object that represents all the tables - of figures in the document. + Gets whether the document has an attached Microsoft Visual Basic for + Applications project. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -686,69 +1002,3404 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly tablesOfFigures: Word.TableOfFiguresCollection;' + content: 'readonly hasVbProject: boolean;' return: - type: - - name: windows - uid: word!Word.Document#windows:member + type: boolean + - name: hyperlinks + uid: word!Word.Document#hyperlinks:member package: word! - fullName: windows - summary: Gets the collection of `Word.Window` objects for the document. + fullName: hyperlinks + summary: >- + Returns a `HyperlinkCollection` object that represents all the hyperlinks + in the document. remarks: >- - \[ [API set: WordApiDesktop - 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'readonly windows: Word.WindowCollection;' + content: 'readonly hyperlinks: Word.HyperlinkCollection;' return: - type: -methods: - - name: addStyle(name, type) - uid: word!Word.Document#addStyle:member(1) + type: + - name: hyphenateCaps + uid: word!Word.Document#hyphenateCaps:member package: word! - fullName: addStyle(name, type) - summary: Adds a style into the document by name and type. + fullName: hyphenateCaps + summary: Specifies whether words in all capital letters can be hyphenated. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenateCaps: boolean;' + return: + type: boolean + - name: hyphenationZone + uid: word!Word.Document#hyphenationZone:member + package: word! + fullName: hyphenationZone + summary: Specifies the width of the hyphenation zone, in points. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenationZone: number;' + return: + type: number + - name: indexes + uid: word!Word.Document#indexes:member + package: word! + fullName: indexes + summary: >- + Returns an `IndexCollection` object that represents all the indexes in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly indexes: Word.IndexCollection;' + return: + type: + - name: isAutoFormatOverrideOn + uid: word!Word.Document#isAutoFormatOverrideOn:member + package: word! + fullName: isAutoFormatOverrideOn + summary: >- + Specifies whether automatic formatting options override formatting + restrictions. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isAutoFormatOverrideOn: boolean;' + return: + type: boolean + - name: isChartDataPointTracked + uid: word!Word.Document#isChartDataPointTracked:member + package: word! + fullName: isChartDataPointTracked + summary: >- + Specifies whether charts in the active document use cell-reference + data-point tracking. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isChartDataPointTracked: boolean;' + return: + type: boolean + - name: isCompatible + uid: word!Word.Document#isCompatible:member + package: word! + fullName: isCompatible + summary: >- + Specifies whether the compatibility option specified by the `type` + property is enabled. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCompatible: boolean;' + return: + type: boolean + - name: isFinal + uid: word!Word.Document#isFinal:member + package: word! + fullName: isFinal + summary: Specifies whether the document is final. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFinal: boolean;' + return: + type: boolean + - name: isFontsSubsetSaved + uid: word!Word.Document#isFontsSubsetSaved:member + package: word! + fullName: isFontsSubsetSaved + summary: >- + Specifies whether Microsoft Word saves a subset of the embedded TrueType + fonts with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFontsSubsetSaved: boolean;' + return: + type: boolean + - name: isFormsDataPrinted + uid: word!Word.Document#isFormsDataPrinted:member + package: word! + fullName: isFormsDataPrinted + summary: >- + Specifies whether Microsoft Word prints onto a preprinted form only the + data entered in the corresponding online form. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataPrinted: boolean;' + return: + type: boolean + - name: isFormsDataSaved + uid: word!Word.Document#isFormsDataSaved:member + package: word! + fullName: isFormsDataSaved + summary: >- + Specifies whether Microsoft Word saves the data entered in a form as a + tab-delimited record for use in a database. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataSaved: boolean;' + return: + type: boolean + - name: isGrammarChecked + uid: word!Word.Document#isGrammarChecked:member + package: word! + fullName: isGrammarChecked + summary: Specifies whether a grammar check has been run on the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isGrammarChecked: boolean;' + return: + type: boolean + - name: isInAutoSave + uid: word!Word.Document#isInAutoSave:member + package: word! + fullName: isInAutoSave + summary: >- + Gets whether the most recent firing of the + `Application.DocumentBeforeSave` event was the result of an automatic save + by the document or a manual save by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isInAutoSave: boolean;' + return: + type: boolean + - name: isInFormsDesign + uid: word!Word.Document#isInFormsDesign:member + package: word! + fullName: isInFormsDesign + summary: Gets whether the document is in form design mode. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isInFormsDesign: boolean;' + return: + type: boolean + - name: isKerningByAlgorithm + uid: word!Word.Document#isKerningByAlgorithm:member + package: word! + fullName: isKerningByAlgorithm + summary: >- + Specifies whether Word kerns half-width Latin characters and punctuation + marks. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isKerningByAlgorithm: boolean;' + return: + type: boolean + - name: isLinguisticDataEmbedded + uid: word!Word.Document#isLinguisticDataEmbedded:member + package: word! + fullName: isLinguisticDataEmbedded + summary: Specifies whether to embed speech and handwriting data. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLinguisticDataEmbedded: boolean;' + return: + type: boolean + - name: isMasterDocument + uid: word!Word.Document#isMasterDocument:member + package: word! + fullName: isMasterDocument + summary: Gets whether this document is a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isMasterDocument: boolean;' + return: + type: boolean + - name: isOptimizedForWord97 + uid: word!Word.Document#isOptimizedForWord97:member + package: word! + fullName: isOptimizedForWord97 + summary: Specifies whether Word optimizes the document for Word 97. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isOptimizedForWord97: boolean;' + return: + type: boolean + - name: isPostScriptPrintedOverText + uid: word!Word.Document#isPostScriptPrintedOverText:member + package: word! + fullName: isPostScriptPrintedOverText + summary: >- + Specifies whether [PRINT + field](https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f) + instructions (such as PostScript commands) in the document are to be + printed on top of text and graphics when a PostScript printer is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPostScriptPrintedOverText: boolean;' + return: + type: boolean + - name: isQuickStyleSetLocked + uid: word!Word.Document#isQuickStyleSetLocked:member + package: word! + fullName: isQuickStyleSetLocked + summary: Specifies whether users can change the Quick Style set. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isQuickStyleSetLocked: boolean;' + return: + type: boolean + - name: isReadOnly + uid: word!Word.Document#isReadOnly:member + package: word! + fullName: isReadOnly + summary: >- + Gets whether changes to the document cannot be saved to the original + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isReadOnly: boolean;' + return: + type: boolean + - name: isReadOnlyRecommended + uid: word!Word.Document#isReadOnlyRecommended:member + package: word! + fullName: isReadOnlyRecommended + summary: >- + Specifies whether Microsoft Word displays a message box whenever a user + opens the document, suggesting that it be opened as read-only. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnlyRecommended: boolean;' + return: + type: boolean + - name: isSnappedToGrid + uid: word!Word.Document#isSnappedToGrid:member + package: word! + fullName: isSnappedToGrid + summary: >- + Specifies whether AutoShapes or East Asian characters are automatically + aligned with an invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToGrid: boolean;' + return: + type: boolean + - name: isSnappedToShapes + uid: word!Word.Document#isSnappedToShapes:member + package: word! + fullName: isSnappedToShapes + summary: >- + Specifies whether AutoShapes or East Asian characters align with invisible + gridlines through other shapes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToShapes: boolean;' + return: + type: boolean + - name: isSpellingChecked + uid: word!Word.Document#isSpellingChecked:member + package: word! + fullName: isSpellingChecked + summary: Specifies whether spelling has been checked throughout the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSpellingChecked: boolean;' + return: + type: boolean + - name: isStyleEnforced + uid: word!Word.Document#isStyleEnforced:member + package: word! + fullName: isStyleEnforced + summary: >- + Specifies whether formatting restrictions are enforced in a protected + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStyleEnforced: boolean;' + return: + type: boolean + - name: isSubdocument + uid: word!Word.Document#isSubdocument:member + package: word! + fullName: isSubdocument + summary: Gets whether this document is a subdocument of a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isSubdocument: boolean;' + return: + type: boolean + - name: isThemeLocked + uid: word!Word.Document#isThemeLocked:member + package: word! + fullName: isThemeLocked + summary: Specifies whether users can change the document theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isThemeLocked: boolean;' + return: + type: boolean + - name: isUserControl + uid: word!Word.Document#isUserControl:member + package: word! + fullName: isUserControl + summary: Specifies whether the document was created or opened by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isUserControl: boolean;' + return: + type: boolean + - name: isVbaSigned + uid: word!Word.Document#isVbaSigned:member + package: word! + fullName: isVbaSigned + summary: Gets whether the VBA project is digitally signed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isVbaSigned: boolean;' + return: + type: boolean + - name: isWriteReserved + uid: word!Word.Document#isWriteReserved:member + package: word! + fullName: isWriteReserved + summary: Gets whether the document is protected with a write password. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isWriteReserved: boolean;' + return: + type: boolean + - name: justificationMode + uid: word!Word.Document#justificationMode:member + package: word! + fullName: justificationMode + summary: Specifies the character spacing adjustment. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + justificationMode: Word.JustificationMode | "Expand" | "Compress" | + "CompressKana"; + return: + type: >- + | "Expand" | + "Compress" | "CompressKana" + - name: kind + uid: word!Word.Document#kind:member + package: word! + fullName: kind + summary: >- + Specifies the format type that Microsoft Word uses when automatically + formatting the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";' + return: + type: >- + | "NotSpecified" | "Letter" + | "Email" + - name: languageDetected + uid: word!Word.Document#languageDetected:member + package: word! + fullName: languageDetected + summary: >- + Specifies whether Microsoft Word has detected the language of the document + text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected: boolean;' + return: + type: boolean + - name: listParagraphs + uid: word!Word.Document#listParagraphs:member + package: word! + fullName: listParagraphs + summary: >- + Gets a `ParagraphCollection` object that represents all the numbered + paragraphs in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listParagraphs: Word.ParagraphCollection;' + return: + type: + - name: lists + uid: word!Word.Document#lists:member + package: word! + fullName: lists + summary: >- + Gets a `ListCollection` object that contains all the formatted lists in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly lists: Word.ListCollection;' + return: + type: + - name: listTemplates + uid: word!Word.Document#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listTemplates: Word.ListTemplateCollection;' + return: + type: + - name: noLineBreakAfter + uid: word!Word.Document#noLineBreakAfter:member + package: word! + fullName: noLineBreakAfter + summary: Specifies the kinsoku characters after which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakAfter: string;' + return: + type: string + - name: noLineBreakBefore + uid: word!Word.Document#noLineBreakBefore:member + package: word! + fullName: noLineBreakBefore + summary: Specifies the kinsoku characters before which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakBefore: string;' + return: + type: string + - name: openEncoding + uid: word!Word.Document#openEncoding:member + package: word! + fullName: openEncoding + summary: Gets the encoding used to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly openEncoding: Word.DocumentEncoding | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | + "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | + "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | + "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | + "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: originalDocumentTitle + uid: word!Word.Document#originalDocumentTitle:member + package: word! + fullName: originalDocumentTitle + summary: Gets the title of the original document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly originalDocumentTitle: string;' + return: + type: string + - name: pageSetup + uid: word!Word.Document#pageSetup:member + package: word! + fullName: pageSetup + summary: Returns a `PageSetup` object that's associated with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly pageSetup: Word.PageSetup;' + return: + type: + - name: paragraphs + uid: word!Word.Document#paragraphs:member + package: word! + fullName: paragraphs + summary: >- + Gets a `ParagraphCollection` object that represents all the paragraphs in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly paragraphs: Word.ParagraphCollection;' + return: + type: + - name: password + uid: word!Word.Document#password:member + package: word! + fullName: password + summary: Sets a password that must be supplied to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'password: string;' + return: + type: string + - name: passwordEncryptionAlgorithm + uid: word!Word.Document#passwordEncryptionAlgorithm:member + package: word! + fullName: passwordEncryptionAlgorithm + summary: Gets the algorithm used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly passwordEncryptionAlgorithm: string;' + return: + type: string + - name: passwordEncryptionKeyLength + uid: word!Word.Document#passwordEncryptionKeyLength:member + package: word! + fullName: passwordEncryptionKeyLength + summary: Gets the key length used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly passwordEncryptionKeyLength: number;' + return: + type: number + - name: passwordEncryptionProvider + uid: word!Word.Document#passwordEncryptionProvider:member + package: word! + fullName: passwordEncryptionProvider + summary: Gets the name of the password encryption provider. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly passwordEncryptionProvider: string;' + return: + type: string + - name: path + uid: word!Word.Document#path:member + package: word! + fullName: path + summary: >- + Gets the disk or the web path to the document (excludes the document + name). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly path: string;' + return: + type: string + - name: printRevisions + uid: word!Word.Document#printRevisions:member + package: word! + fullName: printRevisions + summary: Specifies whether revision marks are printed with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printRevisions: boolean;' + return: + type: boolean + - name: properties + uid: word!Word.Document#properties:member + package: word! + fullName: properties + summary: Gets the properties of the document. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml + + + await Word.run(async (context) => { + const builtInProperties: Word.DocumentProperties = context.document.properties; + builtInProperties.load("*"); // Let's get all! + + await context.sync(); + console.log(JSON.stringify(builtInProperties, null, 4)); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly properties: Word.DocumentProperties;' + return: + type: + - name: protectionType + uid: word!Word.Document#protectionType:member + package: word! + fullName: protectionType + summary: Gets the protection type for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly protectionType: Word.ProtectionType | "NoProtection" | + "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | + "AllowOnlyReading"; + return: + type: >- + | "NoProtection" | + "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | + "AllowOnlyReading" + - name: readabilityStatistics + uid: word!Word.Document#readabilityStatistics:member + package: word! + fullName: readabilityStatistics + summary: >- + Gets a `ReadabilityStatisticCollection` object that represents the + readability statistics for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly readabilityStatistics: Word.ReadabilityStatisticCollection;' + return: + type: + - name: readingLayoutSizeX + uid: word!Word.Document#readingLayoutSizeX:member + package: word! + fullName: readingLayoutSizeX + summary: Specifies the width of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeX: number;' + return: + type: number + - name: readingLayoutSizeY + uid: word!Word.Document#readingLayoutSizeY:member + package: word! + fullName: readingLayoutSizeY + summary: Specifies the height of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeY: number;' + return: + type: number + - name: readingModeIsLayoutFrozen + uid: word!Word.Document#readingModeIsLayoutFrozen:member + package: word! + fullName: readingModeIsLayoutFrozen + summary: >- + Specifies whether pages in reading layout view are frozen for handwritten + markup. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingModeIsLayoutFrozen: boolean;' + return: + type: boolean + - name: removePersonalInformationOnSave + uid: word!Word.Document#removePersonalInformationOnSave:member + package: word! + fullName: removePersonalInformationOnSave + summary: Specifies whether Word removes user information upon saving. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removePersonalInformationOnSave: boolean;' + return: + type: boolean + - name: revisedDocumentTitle + uid: word!Word.Document#revisedDocumentTitle:member + package: word! + fullName: revisedDocumentTitle + summary: Gets the title of the revised document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly revisedDocumentTitle: string;' + return: + type: string + - name: revisions + uid: word!Word.Document#revisions:member + package: word! + fullName: revisions + summary: >- + Gets the collection of revisions that represents the tracked changes in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly revisions: Word.RevisionCollection;' + return: + type: + - name: saved + uid: word!Word.Document#saved:member + package: word! + fullName: saved + summary: >- + 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. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly saved: boolean;' + return: + type: boolean + - name: saveEncoding + uid: word!Word.Document#saveEncoding:member + package: word! + fullName: saveEncoding + summary: Specifies the encoding used when saving the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: saveFormat + uid: word!Word.Document#saveFormat:member + package: word! + fullName: saveFormat + summary: Gets the file format of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | + "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | + "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | + "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | + "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | + "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | + "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | + "StrictOpenXmlDocument"; + return: + type: >- + | "Document" | "Template" + | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" + | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | + "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | + "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | + "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | + "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | + "StrictOpenXmlDocument" + - name: sections + uid: word!Word.Document#sections:member + package: word! + fullName: sections + summary: Gets the collection of section objects in the document. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly sections: Word.SectionCollection;' + return: + type: + - name: selection + uid: word!Word.Document#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly selection: Word.Selection;' + return: + type: + - name: sentences + uid: word!Word.Document#sentences:member + package: word! + fullName: sentences + summary: >- + Gets the `RangeScopedCollection` object that represents all the sentences + in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sentences: Word.RangeScopedCollection;' + return: + type: + - name: settings + uid: word!Word.Document#settings:member + package: word! + fullName: settings + summary: Gets the add-in's settings in the document. + remarks: >- + \[ [API set: WordApi + 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml + + + // Gets all custom settings this add-in set on this document. + + await Word.run(async (context) => { + const settings: Word.SettingCollection = context.document.settings; + settings.load("items"); + await context.sync(); + + if (settings.items.length == 0) { + console.log("There are no settings."); + } else { + console.log("All settings:"); + for (let i = 0; i < settings.items.length; i++) { + console.log(settings.items[i]); + } + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly settings: Word.SettingCollection;' + return: + type: + - name: spellingErrors + uid: word!Word.Document#spellingErrors:member + package: word! + fullName: spellingErrors + summary: >- + Gets a `RangeCollection` object that represents the words identified as + spelling errors in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly spellingErrors: Word.RangeCollection;' + return: + type: + - name: storyRanges + uid: word!Word.Document#storyRanges:member + package: word! + fullName: storyRanges + summary: >- + Gets a `RangeCollection` object that represents all the stories in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly storyRanges: Word.RangeCollection;' + return: + type: + - name: styles + uid: word!Word.Document#styles:member + package: word! + fullName: styles + summary: Gets a `StyleCollection` for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly styles: Word.StyleCollection;' + return: + type: + - name: tableOfAuthoritiesCategories + uid: word!Word.Document#tableOfAuthoritiesCategories:member + package: word! + fullName: tableOfAuthoritiesCategories + summary: >- + Returns a `TableOfAuthoritiesCategoryCollection` object that represents + the available table of authorities categories in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly tableOfAuthoritiesCategories: + Word.TableOfAuthoritiesCategoryCollection; + return: + type: + - name: tables + uid: word!Word.Document#tables:member + package: word! + fullName: tables + summary: >- + Gets a `TableCollection` object that represents all the tables in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tables: Word.TableCollection;' + return: + type: + - name: tablesOfAuthorities + uid: word!Word.Document#tablesOfAuthorities:member + package: word! + fullName: tablesOfAuthorities + summary: >- + Returns a `TableOfAuthoritiesCollection` object that represents all the + tables of authorities in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;' + return: + type: + - name: tablesOfContents + uid: word!Word.Document#tablesOfContents:member + package: word! + fullName: tablesOfContents + summary: >- + Returns a `TableOfContentsCollection` object that represents all the + tables of contents in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfContents: Word.TableOfContentsCollection;' + return: + type: + - name: tablesOfFigures + uid: word!Word.Document#tablesOfFigures:member + package: word! + fullName: tablesOfFigures + summary: >- + Returns a `TableOfFiguresCollection` object that represents all the tables + of figures in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfFigures: Word.TableOfFiguresCollection;' + return: + type: + - name: textEncoding + uid: word!Word.Document#textEncoding:member + package: word! + fullName: textEncoding + summary: Specifies the encoding for saving as encoded text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: textLineEnding + uid: word!Word.Document#textLineEnding:member + package: word! + fullName: textLineEnding + summary: Specifies how Word marks line and paragraph breaks in text files. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | + "Lfcr" | "Lsps"; + return: + type: >- + | "Crlf" | "CrOnly" | + "LfOnly" | "Lfcr" | "Lsps" + - name: trackedChangesAreDateAndTimeRemoved + uid: word!Word.Document#trackedChangesAreDateAndTimeRemoved:member + package: word! + fullName: trackedChangesAreDateAndTimeRemoved + summary: >- + Specifies whether to remove or store date and time metadata for tracked + changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackedChangesAreDateAndTimeRemoved: boolean;' + return: + type: boolean + - name: trackFormatting + uid: word!Word.Document#trackFormatting:member + package: word! + fullName: trackFormatting + summary: Specifies whether to track formatting changes when change tracking is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackFormatting: boolean;' + return: + type: boolean + - name: trackMoves + uid: word!Word.Document#trackMoves:member + package: word! + fullName: trackMoves + summary: Specifies whether to mark moved text when Track Changes is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackMoves: boolean;' + return: + type: boolean + - name: trackRevisions + uid: word!Word.Document#trackRevisions:member + package: word! + fullName: trackRevisions + summary: Specifies whether changes are tracked in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackRevisions: boolean;' + return: + type: boolean + - name: type + uid: word!Word.Document#type:member + package: word! + fullName: type + summary: Gets the document type (template or document). + 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.DocumentType | "Document" | "Template" | "Frameset";' + return: + type: >- + | "Document" | "Template" | + "Frameset" + - name: webSettings + uid: word!Word.Document#webSettings:member + package: word! + fullName: webSettings + summary: Gets the `WebSettings` object for webpage-related attributes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly webSettings: Word.WebSettings;' + return: + type: + - name: windows + uid: word!Word.Document#windows:member + package: word! + fullName: windows + summary: Gets the collection of `Word.Window` objects for the document. + remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly windows: Word.WindowCollection;' + return: + type: + - name: words + uid: word!Word.Document#words:member + package: word! + fullName: words + summary: >- + Gets the `RangeScopedCollection` object that represents each word in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly words: Word.RangeScopedCollection;' + return: + type: + - name: writePassword + uid: word!Word.Document#writePassword:member + package: word! + fullName: writePassword + summary: Sets a password for saving changes to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'writePassword: string;' + return: + type: string + - name: xmlAreAdvancedErrorsShown + uid: word!Word.Document#xmlAreAdvancedErrorsShown:member + package: word! + fullName: xmlAreAdvancedErrorsShown + summary: >- + Specifies whether error messages are generated from built-in Word messages + or MSXML (Microsoft XML). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlAreAdvancedErrorsShown: boolean;' + return: + type: boolean + - name: xmlIsXsltUsedWhenSaving + uid: word!Word.Document#xmlIsXsltUsedWhenSaving:member + package: word! + fullName: xmlIsXsltUsedWhenSaving + summary: >- + Specifies whether to save a document through an Extensible Stylesheet + Language Transformation (XSLT). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlIsXsltUsedWhenSaving: boolean;' + return: + type: boolean + - name: xmlSaveThroughXSLT + uid: word!Word.Document#xmlSaveThroughXSLT:member + package: word! + fullName: xmlSaveThroughXSLT + summary: >- + Specifies the path and file name for the XSLT to apply when saving a + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlSaveThroughXSLT: string;' + return: + type: string +methods: + - name: acceptAllRevisions() + uid: word!Word.Document#acceptAllRevisions:member(1) + package: word! + fullName: acceptAllRevisions() + summary: Accepts all tracked changes in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'acceptAllRevisions(): void;' + return: + type: void + description: '' + - name: acceptAllRevisionsShown() + uid: word!Word.Document#acceptAllRevisionsShown:member(1) + package: word! + fullName: acceptAllRevisionsShown() + summary: Accepts all revisions in the document that are displayed on the screen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'acceptAllRevisionsShown(): void;' + return: + type: void + description: '' + - name: activate() + uid: word!Word.Document#activate:member(1) + package: word! + fullName: activate() + summary: Activates the document so that it becomes the active document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activate(): void;' + return: + type: void + description: '' + - name: addStyle(name, type) + uid: word!Word.Document#addStyle:member(1) + package: word! + fullName: addStyle(name, type) + summary: Adds a style into the document by name and type. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml + + + // Adds a new style. + + await Word.run(async (context) => { + const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value; + if (newStyleName == "") { + console.warn("Enter a style name to add."); + return; + } + + const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName); + style.load(); + await context.sync(); + + if (!style.isNullObject) { + console.warn( + `There's an existing style with the same name '${newStyleName}'! Please provide another style name.` + ); + return; + } + + const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType; + context.document.addStyle(newStyleName, newStyleType); + await context.sync(); + + console.log(newStyleName + " has been added to the style list."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'addStyle(name: string, type: Word.StyleType): Word.Style;' + parameters: + - id: name + description: Required. A string representing the style name. + type: string + - id: type + description: >- + Required. The style type, including character, list, paragraph, or + table. + type: + return: + type: + description: '' + - name: addStyle(name, type) + uid: word!Word.Document#addStyle:member(2) + package: word! + fullName: addStyle(name, type) + summary: Adds a style into the document by name and type. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + addStyle(name: string, type: "Character" | "List" | "Paragraph" | + "Table"): Word.Style; + parameters: + - id: name + description: Required. A string representing the style name. + type: string + - id: type + description: >- + Required. The style type, including character, list, paragraph, or + table. + type: '"Character" | "List" | "Paragraph" | "Table"' + return: + type: + description: '' + - name: addToFavorites() + uid: word!Word.Document#addToFavorites:member(1) + package: word! + fullName: addToFavorites() + summary: >- + Creates a shortcut to the document or hyperlink and adds it to the + **Favorites** folder. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addToFavorites(): void;' + return: + type: void + description: '' + - name: applyQuickStyleSet(style) + uid: word!Word.Document#applyQuickStyleSet:member(1) + package: word! + fullName: applyQuickStyleSet(style) + summary: Applies the specified Quick Style set to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;' + parameters: + - id: style + description: The style set to apply. + type: + return: + type: void + description: '' + - name: applyQuickStyleSet(style) + uid: word!Word.Document#applyQuickStyleSet:member(2) + package: word! + fullName: applyQuickStyleSet(style) + summary: Applies the specified Quick Style set to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyQuickStyleSet(style: "SessionStart" | "Template"): void;' + parameters: + - id: style + description: The style set to apply. + type: '"SessionStart" | "Template"' + return: + type: void + description: '' + - name: applyTheme(name) + uid: word!Word.Document#applyTheme:member(1) + package: word! + fullName: applyTheme(name) + summary: Applies the specified theme to this document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyTheme(name: string): void;' + parameters: + - id: name + description: The name of the theme. + type: string + return: + type: void + description: '' + - name: autoFormat() + uid: word!Word.Document#autoFormat:member(1) + package: word! + fullName: autoFormat() + summary: Automatically formats the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFormat(): void;' + return: + type: void + description: '' + - name: canCheckin() + uid: word!Word.Document#canCheckin:member(1) + package: word! + fullName: canCheckin() + summary: Returns `true` if Microsoft Word can check in the document to a server. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'canCheckin(): OfficeExtension.ClientResult;' + return: + type: >- + <boolean> + description: '`true` if the document can be checked in; otherwise, `false`.' + - name: checkConsistencyJapanese() + uid: word!Word.Document#checkConsistencyJapanese:member(1) + package: word! + fullName: checkConsistencyJapanese() + summary: >- + Searches all text in a Japanese language document and displays instances + where character usage is inconsistent for the same words. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'checkConsistencyJapanese(): void;' + return: + type: void + description: '' + - name: checkGrammar() + uid: word!Word.Document#checkGrammar:member(1) + package: word! + fullName: checkGrammar() + summary: Begins a spelling and grammar check for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'checkGrammar(): void;' + return: + type: void + description: '' + - name: checkIn(options) + uid: word!Word.Document#checkIn:member(1) + package: word! + fullName: checkIn(options) + summary: >- + Checks in the document from the local computer to a server and sets the + local document to read-only so that it cannot be edited locally. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'checkIn(options?: Word.DocumentCheckInOptions): void;' + parameters: + - id: options + description: Optional. Configuration options for checking in the document. + type: + return: + type: void + description: '' + - name: checkInWithVersion(options) + uid: word!Word.Document#checkInWithVersion:member(1) + package: word! + fullName: checkInWithVersion(options) + summary: >- + Saves the document to a server from a local computer, and sets the local + document to read-only so that it cannot be edited locally. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): + void; + parameters: + - id: options + description: >- + Optional. Configuration options for checking in the document with + version control. + type: + return: + type: void + description: '' + - name: checkSpelling(options) + uid: word!Word.Document#checkSpelling:member(1) + package: word! + fullName: checkSpelling(options) + summary: Begins a spelling check for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;' + parameters: + - id: options + description: Optional. Configuration options for the spell checking operation. + type: + return: + type: void + description: '' + - name: close(closeBehavior) + uid: word!Word.Document#close:member(1) + package: word! + fullName: close(closeBehavior) + summary: |- + Closes the current document. + + Note: This API isn't supported in Word on the web. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml + + + // Closes the document with default behavior + + // for current state of the document. + + await Word.run(async (context) => { + context.document.close(); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'close(closeBehavior?: Word.CloseBehavior): void;' + parameters: + - id: closeBehavior + description: >- + Optional. The close behavior must be 'Save' or 'SkipSave'. Default + value is 'Save'. + type: + return: + type: void + description: '' + - name: close(closeBehavior) + uid: word!Word.Document#close:member(2) + package: word! + fullName: close(closeBehavior) + summary: |- + Closes the current document. + + Note: This API isn't supported in Word on the web. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'close(closeBehavior?: "Save" | "SkipSave"): void;' + parameters: + - id: closeBehavior + description: >- + Optional. The close behavior must be 'Save' or 'SkipSave'. Default + value is 'Save'. + type: '"Save" | "SkipSave"' + return: + type: void + description: '' + - name: closePrintPreview() + uid: word!Word.Document#closePrintPreview:member(1) + package: word! + fullName: closePrintPreview() + summary: Switches the document from print preview to the previous view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'closePrintPreview(): void;' + return: + type: void + description: '' + - name: compare(filePath, documentCompareOptions) + uid: word!Word.Document#compare:member(1) + package: word! + fullName: compare(filePath, documentCompareOptions) + summary: >- + Displays revision marks that indicate where the specified document differs + from another document. + remarks: >- + \[ [API set: WordApiDesktop + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml + + + // Compares the current document with a specified external document. + + await Word.run(async (context) => { + // Absolute path of an online or local document. + const filePath = (document.getElementById("filePath") as HTMLInputElement).value; + // Options that configure the compare operation. + const options: Word.DocumentCompareOptions = { + compareTarget: Word.CompareTarget.compareTargetCurrent, + detectFormatChanges: false + // Other options you choose... + }; + context.document.compare(filePath, options); + + await context.sync(); + + console.log("Differences shown in the current document."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + compare(filePath: string, documentCompareOptions?: + Word.DocumentCompareOptions): void; + parameters: + - id: filePath + description: >- + Required. The path of the document with which the specified document + is compared. + type: string + - id: documentCompareOptions + description: >- + Optional. The additional options that specifies the behavior of + comparing document. + type: + return: + type: void + description: '' + - name: compareFromBase64(base64File, documentCompareOptions) + uid: word!Word.Document#compareFromBase64:member(1) + package: word! + fullName: compareFromBase64(base64File, documentCompareOptions) + summary: >- + Displays revision marks that indicate where the specified document differs + from another document. + remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + compareFromBase64(base64File: string, documentCompareOptions?: + Word.DocumentCompareOptions): void; + parameters: + - id: base64File + description: >- + Required. The Base64-encoded content of the document with which the + specified document is compared. + type: string + - id: documentCompareOptions + description: >- + Optional. The additional options that specify the behavior for + comparing the documents. Note that the `compareTarget` option isn't + allowed to be `CompareTargetSelected` in this API. + type: + return: + type: void + description: '' + - name: computeStatistics(statistic, includeFootnotesAndEndnotes) + uid: word!Word.Document#computeStatistics:member(1) + package: word! + fullName: computeStatistics(statistic, includeFootnotesAndEndnotes) + summary: Returns a statistic based on the contents of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + computeStatistics(statistic: Word.Statistic, + includeFootnotesAndEndnotes?: boolean): + OfficeExtension.ClientResult; + parameters: + - id: statistic + description: The type of statistic to return. + type: + - id: includeFootnotesAndEndnotes + description: >- + Optional. Whether to include footnotes and endnotes. The default + value is `false`. + type: boolean + return: + type: <number> + description: '' + - name: computeStatistics(statistic, includeFootnotesAndEndnotes) + uid: word!Word.Document#computeStatistics:member(2) + package: word! + fullName: computeStatistics(statistic, includeFootnotesAndEndnotes) + summary: Returns a statistic based on the contents of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" + | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", + includeFootnotesAndEndnotes?: boolean): + OfficeExtension.ClientResult; + parameters: + - id: statistic + description: The type of statistic to return. + type: >- + "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | + "CharactersWithSpaces" | "FarEastCharacters" + - id: includeFootnotesAndEndnotes + description: >- + Optional. Whether to include footnotes and endnotes. The default + value is `false`. + type: boolean + return: + type: <number> + description: '' + - name: convert() + uid: word!Word.Document#convert:member(1) + package: word! + fullName: convert() + summary: Converts the file to the newest format and enables all features. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convert(): void;' + return: + type: void + description: '' + - name: convertAutoHyphens() + uid: word!Word.Document#convertAutoHyphens:member(1) + package: word! + fullName: convertAutoHyphens() + summary: Converts automatic hyphens to manual hyphens. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertAutoHyphens(): void;' + return: + type: void + description: '' + - name: convertNumbersToText(numberType) + uid: word!Word.Document#convertNumbersToText:member(1) + package: word! + fullName: convertNumbersToText(numberType) + summary: >- + Changes the list numbers and [LISTNUM + fields](https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82) + in the document to text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertNumbersToText(numberType?: Word.NumberType): void;' + parameters: + - id: numberType + description: Optional. The type of numbering to convert. + type: + return: + type: void + description: '' + - name: convertNumbersToText(numberType) + uid: word!Word.Document#convertNumbersToText:member(2) + package: word! + fullName: convertNumbersToText(numberType) + summary: >- + Changes the list numbers and [LISTNUM + fields](https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82) + in the document to text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + convertNumbersToText(numberType?: "Paragraph" | "ListNum" | + "AllNumbers"): void; + parameters: + - id: numberType + description: Optional. The type of numbering to convert. + type: '"Paragraph" | "ListNum" | "AllNumbers"' + return: + type: void + description: '' + - name: convertVietnameseDocument(codePageOrigin) + uid: word!Word.Document#convertVietnameseDocument:member(1) + package: word! + fullName: convertVietnameseDocument(codePageOrigin) + summary: >- + Reconverts a Vietnamese document to Unicode using a code page other than + the default. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertVietnameseDocument(codePageOrigin: number): void;' + parameters: + - id: codePageOrigin + description: The code page to use. + type: number + return: + type: void + description: '' + - name: copyStylesFromTemplate(StyleTemplate) + uid: word!Word.Document#copyStylesFromTemplate:member(1) + package: word! + fullName: copyStylesFromTemplate(StyleTemplate) + summary: Copies styles from the specified template to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copyStylesFromTemplate(StyleTemplate: string): void;' + parameters: + - id: StyleTemplate + description: The template to copy styles from. + type: string + return: + type: void + description: '' + - name: countNumberedItems(options) + uid: word!Word.Document#countNumberedItems:member(1) + package: word! + fullName: countNumberedItems(options) + summary: >- + Returns the number of bulleted or numbered items and [LISTNUM + fields](https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82) + in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Configuration options for counting numbered items. + type: + return: + type: <number> + description: The count of numbered items. + - name: deleteAllComments() + uid: word!Word.Document#deleteAllComments:member(1) + package: word! + fullName: deleteAllComments() + summary: Deletes all comments from the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'deleteAllComments(): void;' + return: + type: void + description: '' + - name: deleteAllCommentsShown() + uid: word!Word.Document#deleteAllCommentsShown:member(1) + package: word! + fullName: deleteAllCommentsShown() + summary: Deletes all revisions in the document that are displayed on the screen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'deleteAllCommentsShown(): void;' + return: + type: void + description: '' + - name: deleteAllInkAnnotations() + uid: word!Word.Document#deleteAllInkAnnotations:member(1) + package: word! + fullName: deleteAllInkAnnotations() + summary: Deletes all handwritten ink annotations in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'deleteAllInkAnnotations(): void;' + return: + type: void + description: '' + - name: deleteBookmark(name) + uid: word!Word.Document#deleteBookmark:member(1) + package: word! + fullName: deleteBookmark(name) + summary: Deletes a bookmark, if it exists, from the document. + remarks: >- + \[ [API set: WordApi + 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteBookmark(name: string): void;' + parameters: + - id: name + description: Required. The case-insensitive bookmark name. + type: string + return: + type: void + description: '' + - name: detectLanguage() + uid: word!Word.Document#detectLanguage:member(1) + package: word! + fullName: detectLanguage() + summary: Analyzes the document text to determine the language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'detectLanguage(): void;' + return: + type: void + description: '' + - name: endReview(options) + uid: word!Word.Document#endReview:member(1) + package: word! + fullName: endReview(options) + summary: Terminates a review of the file that has been sent for review. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'endReview(options?: Word.DocumentEndReviewOptions): void;' + parameters: + - id: options + description: Optional. Configuration options for ending the review process. + type: + return: + type: void + description: '' + - name: exportAsFixedFormat(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat:member(1) + package: word! + fullName: exportAsFixedFormat(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat(outputFileName: string, exportFormat: + Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): + void; + parameters: + - id: outputFileName + description: The name of the output file. + type: string + - id: exportFormat + description: The export format. + type: + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: exportAsFixedFormat(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat:member(2) + package: word! + fullName: exportAsFixedFormat(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", + options?: Word.DocumentExportAsFixedFormatOptions): void; + parameters: + - id: outputFileName + description: The name of the output file. + type: string + - id: exportFormat + description: The export format. + type: '"Pdf" | "Xps"' + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: exportAsFixedFormat2(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat2:member(1) + package: word! + fullName: exportAsFixedFormat2(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat2(outputFileName: string, exportFormat: + Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): + void; + parameters: + - id: outputFileName + description: The output file name. + type: string + - id: exportFormat + description: The format to export (PDF/XPS). + type: + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: exportAsFixedFormat2(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat2:member(2) + package: word! + fullName: exportAsFixedFormat2(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | + "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void; + parameters: + - id: outputFileName + description: The output file name. + type: string + - id: exportFormat + description: The format to export (PDF/XPS). + type: '"Pdf" | "Xps"' + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: exportAsFixedFormat3(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat3:member(1) + package: word! + fullName: exportAsFixedFormat3(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format with improved tagging. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat3(outputFileName: string, exportFormat: + Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): + void; + parameters: + - id: outputFileName + description: The output file name. + type: string + - id: exportFormat + description: The format to export (PDF/XPS). + type: + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: exportAsFixedFormat3(outputFileName, exportFormat, options) + uid: word!Word.Document#exportAsFixedFormat3:member(2) + package: word! + fullName: exportAsFixedFormat3(outputFileName, exportFormat, options) + summary: Saves the document in PDF or XPS format with improved tagging. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | + "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void; + parameters: + - id: outputFileName + description: The output file name. + type: string + - id: exportFormat + description: The format to export (PDF/XPS). + type: '"Pdf" | "Xps"' + - id: options + description: Optional. Configuration options for the export operation. + type: >- + + return: + type: void + description: '' + - name: fitToPages() + uid: word!Word.Document#fitToPages:member(1) + package: word! + fullName: fitToPages() + summary: >- + Decreases the font size of text just enough so that the document page + count drops by one. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitToPages(): void;' + return: + type: void + description: '' + - name: followHyperlink(options) + uid: word!Word.Document#followHyperlink:member(1) + package: word! + fullName: followHyperlink(options) + summary: >- + Displays a cached document, if it has already been downloaded. Otherwise, + this method resolves the hyperlink, downloads the target document, and + displays the document in the appropriate application. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;' + parameters: + - id: options + description: Optional. Configuration options for following the hyperlink. + type: + return: + type: void + description: '' + - name: freezeLayout() + uid: word!Word.Document#freezeLayout:member(1) + package: word! + fullName: freezeLayout() + summary: Fixes the layout of the document in Web view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'freezeLayout(): void;' + return: + type: void + description: '' + - name: getAnnotationById(id) + uid: word!Word.Document#getAnnotationById:member(1) + package: word! + fullName: getAnnotationById(id) + summary: >- + Gets the annotation by ID. Throws an `ItemNotFound` error if annotation + isn't found. + remarks: >- + \[ [API set: WordApi + 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getAnnotationById(id: string): Word.Annotation;' + parameters: + - id: id + description: The ID of the annotation to get. + type: string + return: + type: + description: '' + - name: getBookmarkRange(name) + uid: word!Word.Document#getBookmarkRange:member(1) + package: word! + fullName: getBookmarkRange(name) + summary: >- + Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark + doesn't exist. + remarks: >- + \[ [API set: WordApi + 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getBookmarkRange(name: string): Word.Range;' + parameters: + - id: name + description: Required. The case-insensitive bookmark name. + type: string + return: + type: + description: '' + - name: getBookmarkRangeOrNullObject(name) + uid: word!Word.Document#getBookmarkRangeOrNullObject:member(1) + package: word! + fullName: getBookmarkRangeOrNullObject(name) + summary: >- + Gets a bookmark's range. If the bookmark doesn't exist, 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 + 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getBookmarkRangeOrNullObject(name: string): Word.Range;' + parameters: + - id: name + description: Required. The case-insensitive bookmark name. + type: string + return: + type: + description: '' + - name: getContentControls(options) + uid: word!Word.Document#getContentControls:member(1) + package: word! + fullName: getContentControls(options) + summary: Gets the currently supported content controls in the document. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + Important: If specific types are provided in the options parameter, only + content controls of supported types are returned. Be aware that an + exception will be thrown on using methods of a generic + [Word.ContentControl](xref:word!Word.ContentControl:class) that aren't + relevant for the specific type. With time, additional types of content + controls may be supported. Therefore, your add-in should request and + handle specific types of content controls. + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml + + + // Toggles the isChecked property on all checkbox content controls. + + await Word.run(async (context) => { + let contentControls = context.document.getContentControls({ + types: [Word.ContentControlType.checkBox] + }); + contentControls.load("items"); + + await context.sync(); + + const length = contentControls.items.length; + console.log(`Number of checkbox content controls: ${length}`); + + if (length <= 0) { + return; + } + + const checkboxContentControls = []; + for (let i = 0; i < length; i++) { + let contentControl = contentControls.items[i]; + contentControl.load("id,checkboxContentControl/isChecked"); + checkboxContentControls.push(contentControl); + } + + await context.sync(); + + console.log("isChecked state before:"); + const updatedCheckboxContentControls = []; + for (let i = 0; i < checkboxContentControls.length; i++) { + const currentCheckboxContentControl = checkboxContentControls[i]; + const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked; + console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`); + + currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore; + currentCheckboxContentControl.load("id,checkboxContentControl/isChecked"); + updatedCheckboxContentControls.push(currentCheckboxContentControl); + } + + await context.sync(); + + console.log("isChecked state after:"); + for (let i = 0; i < updatedCheckboxContentControls.length; i++) { + const currentCheckboxContentControl = updatedCheckboxContentControls[i]; + console.log( + `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}` + ); + } + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + getContentControls(options?: Word.ContentControlOptions): + Word.ContentControlCollection; + parameters: + - id: options + description: Optional. Options that define which content controls are returned. + type: + return: + type: + description: '' + - name: getCrossReferenceItems(referenceType) + uid: word!Word.Document#getCrossReferenceItems:member(1) + package: word! + fullName: getCrossReferenceItems(referenceType) + summary: >- + Returns an array of items that can be cross-referenced based on the + specified cross-reference type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + getCrossReferenceItems(referenceType: Word.ReferenceType): + OfficeExtension.ClientResult; + parameters: + - id: referenceType + description: The type of reference. + type: + return: + type: >- + <string[]> + description: '' + - name: getCrossReferenceItems(referenceType) + uid: word!Word.Document#getCrossReferenceItems:member(2) + package: word! + fullName: getCrossReferenceItems(referenceType) + summary: >- + Returns an array of items that can be cross-referenced based on the + specified cross-reference type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | + "Bookmark" | "Footnote" | "Endnote"): + OfficeExtension.ClientResult; + parameters: + - id: referenceType + description: The type of reference. + type: '"NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"' + return: + type: >- + <string[]> + description: '' + - name: getEndnoteBody() + uid: word!Word.Document#getEndnoteBody:member(1) + package: word! + fullName: getEndnoteBody() + summary: Gets the document's endnotes in a single body. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getEndnoteBody(): Word.Body;' + return: + type: + description: '' + - name: getFootnoteBody() + uid: word!Word.Document#getFootnoteBody:member(1) + package: word! + fullName: getFootnoteBody() + summary: Gets the document's footnotes in a single body. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFootnoteBody(): Word.Body;' + return: + type: + description: '' + - name: getParagraphByUniqueLocalId(id) + uid: word!Word.Document#getParagraphByUniqueLocalId:member(1) + package: word! + fullName: getParagraphByUniqueLocalId(id) + summary: >- + Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error + if the collection is empty. + remarks: >- + \[ [API set: WordApi + 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml + + + await Word.run(async (context) => { + const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value; + const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId); + paragraph.load(); + await paragraph.context.sync(); + + console.log(paragraph); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getParagraphByUniqueLocalId(id: string): Word.Paragraph;' + parameters: + - id: id + description: >- + Required. Unique local ID in standard 8-4-4-4-12 GUID format without + curly braces. Note that the ID differs across sessions and + coauthors. + type: string + return: + type: + description: '' + - name: getRange(options) + uid: word!Word.Document#getRange:member(1) + package: word! + fullName: getRange(options) + summary: >- + Returns a `Range` object by using the specified starting and ending + character positions. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getRange(options?: Word.DocumentRangeOptions): Word.Range;' + parameters: + - id: options + description: Optional. Configuration options for specifying the range parameters. + type: + return: + type: + description: '' + - name: getSelection() + uid: word!Word.Document#getSelection:member(1) + package: word! + fullName: getSelection() + summary: >- + Gets the current selection of the document. Multiple selections aren't + supported. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Run a batch operation against the Word object model. + + await Word.run(async (context) => { + + const textSample = 'This is an example of the insert text method. This is a method ' + + 'which allows users to insert text into a selection. It can insert text into a ' + + 'relative location or it can overwrite the current selection. Since the ' + + 'getSelection method returns a range object, look up the range object documentation ' + + 'for everything you can do with a selection.'; + + // Create a range proxy object for the current selection. + const range = context.document.getSelection(); + + // Queue a command to insert text at the end of the selection. + range.insertText(textSample, Word.InsertLocation.end); + + // Synchronize the document state by executing the queued commands, + // and return a promise to indicate task completion. + await context.sync(); + console.log('Inserted the text at the end of the selection.'); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getSelection(): Word.Range;' + return: + type: + description: '' + - name: getStyles() + uid: word!Word.Document#getStyles:member(1) + package: word! + fullName: getStyles() + summary: >- + Gets a StyleCollection object that represents the whole style set of the + document. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml + + + // Gets the number of available styles stored with the document. + + await Word.run(async (context) => { + const styles: Word.StyleCollection = context.document.getStyles(); + const count = styles.getCount(); + await context.sync(); + + console.log(`Number of styles: ${count.value}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'getStyles(): Word.StyleCollection;' + return: + type: + description: '' + - name: goTo(options) + uid: word!Word.Document#goTo:member(1) + package: word! + fullName: goTo(options) + summary: >- + Returns a `Range` object that represents the start position of the + specified item, such as a page, bookmark, or field. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'goTo(options?: Word.GoToOptions): Word.Range;' + parameters: + - id: options + description: >- + Optional. Configuration options for specifying the `goTo` + parameters. + type: + return: + type: + description: '' + - name: importStylesFromJson(stylesJson, importedStylesConflictBehavior) + uid: word!Word.Document#importStylesFromJson:member(1) + package: word! + fullName: importStylesFromJson(stylesJson, importedStylesConflictBehavior) + summary: Import styles from a JSON-formatted string. + remarks: >- + \[ [API set: WordApi + 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - // Adds a new style. + + Note: The `importedStylesConflictBehavior` parameter was introduced in + WordApiDesktop 1.1. + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml + + + // Imports styles from JSON. await Word.run(async (context) => { - const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value; - if (newStyleName == "") { - console.warn("Enter a style name to add."); - return; - } + const str = + '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}'; + const styles = context.document.importStylesFromJson(str); + + // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default. + ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore); - const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName); - style.load(); await context.sync(); + console.log("Styles imported from JSON:", styles); + }); - if (!style.isNullObject) { - console.warn( - `There's an existing style with the same name '${newStyleName}'! Please provide another style name.` - ); - return; - } + ``` - const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType; - context.document.addStyle(newStyleName, newStyleType); - await context.sync(); + isPreview: false + isDeprecated: false + syntax: + content: >- + importStylesFromJson(stylesJson: string, + importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): + OfficeExtension.ClientResult; + parameters: + - id: stylesJson + description: Required. A JSON-formatted string representing the styles. + type: string + - id: importedStylesConflictBehavior + description: >- + Optional. Specifies how to handle any imported styles with the same + name as existing styles in the current document. + type: + return: + type: >- + <string[]> + description: '' + - name: importStylesFromJson(stylesJson, importedStylesConflictBehavior) + uid: word!Word.Document#importStylesFromJson:member(2) + package: word! + fullName: importStylesFromJson(stylesJson, importedStylesConflictBehavior) + summary: Import styles from a JSON-formatted string. + remarks: >- + \[ [API set: WordApi + 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - console.log(newStyleName + " has been added to the style list."); + + Note: The `importedStylesConflictBehavior` parameter was introduced in + WordApiDesktop 1.1. + + isPreview: false + isDeprecated: false + syntax: + content: >- + importStylesFromJson(stylesJson: string, + importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): + OfficeExtension.ClientResult; + parameters: + - id: stylesJson + description: Required. A JSON-formatted string representing the styles. + type: string + - id: importedStylesConflictBehavior + description: >- + Optional. Specifies how to handle any imported styles with the same + name as existing styles in the current document. + type: '"Ignore" | "Overwrite" | "CreateNew"' + return: + type: >- + <string[]> + description: '' + - name: insertFileFromBase64(base64File, insertLocation, insertFileOptions) + uid: word!Word.Document#insertFileFromBase64:member(1) + package: word! + fullName: insertFileFromBase64(base64File, insertLocation, insertFileOptions) + summary: >- + Inserts a document into the target document at a specific location with + additional properties. Headers, footers, watermarks, and other section + properties are copied by default. + remarks: >- + \[ [API set: WordApi + 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + 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 + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml + + + // Inserts content (applying selected settings) from another document + passed in as a Base64-encoded string. + + await Word.run(async (context) => { + // Use the Base64-encoded string representation of the selected .docx file. + context.document.insertFileFromBase64(externalDocument, "Replace", { + importTheme: true, + importStyles: true, + importParagraphSpacing: true, + importPageColor: true, + importChangeTrackingMode: true, + importCustomProperties: true, + importCustomXmlParts: true, + importDifferentOddEvenPages: true + }); + await context.sync(); }); ``` @@ -756,234 +4407,226 @@ methods: isPreview: false isDeprecated: false syntax: - content: 'addStyle(name: string, type: Word.StyleType): Word.Style;' + content: >- + insertFileFromBase64(base64File: string, insertLocation: + Word.InsertLocation.replace | Word.InsertLocation.start | + Word.InsertLocation.end | "Replace" | "Start" | "End", + insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; parameters: - - id: name - description: Required. A string representing the style name. + - id: base64File + description: Required. The Base64-encoded content of a .docx file. type: string - - id: type + - id: insertLocation + description: Required. The value must be 'Replace', 'Start', or 'End'. + type: >- + | | | "Replace" | "Start" | + "End" + - id: insertFileOptions description: >- - Required. The style type, including character, list, paragraph, or - table. - type: + Optional. The additional properties that should be imported to the + destination document. + type: return: - type: + type: description: '' - - name: addStyle(name, type) - uid: word!Word.Document#addStyle:member(2) + - name: load(options) + uid: word!Word.Document#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: false + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: |- + + + #### Examples + + ```TypeScript + // Run a batch operation against the Word object model. + await Word.run(async (context) => { + + // Create a proxy object for the document. + const thisDocument = context.document; + + // Queue a command to load content control properties. + thisDocument.load('contentControls/id, contentControls/text, contentControls/tag'); + + // Synchronize the document state by executing the queued commands, + // and return a promise to indicate task completion. + await context.sync(); + if (thisDocument.contentControls.items.length !== 0) { + for (let i = 0; i < thisDocument.contentControls.items.length; i++) { + console.log(thisDocument.contentControls.items[i].id); + console.log(thisDocument.contentControls.items[i].text); + console.log(thisDocument.contentControls.items[i].tag); + } + } else { + console.log('No content controls in this document.'); + } + }); + ``` + - name: load(propertyNames) + uid: word!Word.Document#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: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Document;' + 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.Document#load:member(3) package: word! - fullName: addStyle(name, type) - summary: Adds a style into the document by name and type. - remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + 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: false isDeprecated: false syntax: - content: >- - addStyle(name: string, type: "Character" | "List" | "Paragraph" | - "Table"): Word.Style; + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Document; parameters: - - id: name - description: Required. A string representing the style name. - type: string - - id: type + - id: propertyNamesAndPaths description: >- - Required. The style type, including character, list, paragraph, or - table. - type: '"Character" | "List" | "Paragraph" | "Table"' + `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: + type: description: '' - - name: close(closeBehavior) - uid: word!Word.Document#close:member(1) + - name: lockServerFile() + uid: word!Word.Document#lockServerFile:member(1) package: word! - fullName: close(closeBehavior) - summary: |- - Closes the current document. - - Note: This API isn't supported in Word on the web. + fullName: lockServerFile() + summary: Locks the file on the server preventing anyone else from editing it. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml - - - // Closes the document with default behavior - - // for current state of the document. - - await Word.run(async (context) => { - context.document.close(); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'close(closeBehavior?: Word.CloseBehavior): void;' - parameters: - - id: closeBehavior - description: >- - Optional. The close behavior must be 'Save' or 'SkipSave'. Default - value is 'Save'. - type: + content: 'lockServerFile(): void;' return: type: void description: '' - - name: close(closeBehavior) - uid: word!Word.Document#close:member(2) + - name: makeCompatibilityDefault() + uid: word!Word.Document#makeCompatibilityDefault:member(1) package: word! - fullName: close(closeBehavior) - summary: |- - Closes the current document. - - Note: This API isn't supported in Word on the web. + fullName: makeCompatibilityDefault() + summary: Sets the compatibility options. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'close(closeBehavior?: "Save" | "SkipSave"): void;' - parameters: - - id: closeBehavior - description: >- - Optional. The close behavior must be 'Save' or 'SkipSave'. Default - value is 'Save'. - type: '"Save" | "SkipSave"' + content: 'makeCompatibilityDefault(): void;' return: type: void description: '' - - name: compare(filePath, documentCompareOptions) - uid: word!Word.Document#compare:member(1) + - name: manualHyphenation() + uid: word!Word.Document#manualHyphenation:member(1) package: word! - fullName: compare(filePath, documentCompareOptions) - summary: >- - Displays revision marks that indicate where the specified document differs - from another document. + fullName: manualHyphenation() + summary: Initiates manual hyphenation of a document, one line at a time. remarks: >- - \[ [API set: WordApiDesktop - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml - - - // Compares the current document with a specified external document. - - await Word.run(async (context) => { - // Absolute path of an online or local document. - const filePath = (document.getElementById("filePath") as HTMLInputElement).value; - // Options that configure the compare operation. - const options: Word.DocumentCompareOptions = { - compareTarget: Word.CompareTarget.compareTargetCurrent, - detectFormatChanges: false - // Other options you choose... - }; - context.document.compare(filePath, options); - - await context.sync(); - - console.log("Differences shown in the current document."); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: >- - compare(filePath: string, documentCompareOptions?: - Word.DocumentCompareOptions): void; - parameters: - - id: filePath - description: >- - Required. The path of the document with which the specified document - is compared. - type: string - - id: documentCompareOptions - description: >- - Optional. The additional options that specifies the behavior of - comparing document. - type: + content: 'manualHyphenation(): void;' return: type: void description: '' - - name: compareFromBase64(base64File, documentCompareOptions) - uid: word!Word.Document#compareFromBase64:member(1) + - name: merge(fileName, options) + uid: word!Word.Document#merge:member(1) package: word! - fullName: compareFromBase64(base64File, documentCompareOptions) + fullName: merge(fileName, options) summary: >- - Displays revision marks that indicate where the specified document differs - from another document. + Merges the changes marked with revision marks from one document to + another. remarks: >- - \[ [API set: WordApiDesktop - 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: >- - compareFromBase64(base64File: string, documentCompareOptions?: - Word.DocumentCompareOptions): void; + content: 'merge(fileName: string, options?: Word.DocumentMergeOptions): void;' parameters: - - id: base64File - description: >- - Required. The Base64-encoded content of the document with which the - specified document is compared. + - id: fileName + description: The name of the file to merge. type: string - - id: documentCompareOptions - description: >- - Optional. The additional options that specify the behavior for - comparing the documents. Note that the `compareTarget` option isn't - allowed to be `CompareTargetSelected` in this API. - type: + - id: options + description: Optional. Configuration options for the merge operation. + type: return: type: void description: '' - - name: deleteBookmark(name) - uid: word!Word.Document#deleteBookmark:member(1) + - name: post() + uid: word!Word.Document#post:member(1) package: word! - fullName: deleteBookmark(name) - summary: Deletes a bookmark, if it exists, from the document. + fullName: post() + summary: Posts the document to a public folder in Microsoft Exchange. remarks: >- - \[ [API set: WordApi - 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'deleteBookmark(name: string): void;' - parameters: - - id: name - description: Required. The case-insensitive bookmark name. - type: string + content: 'post(): void;' return: type: void description: '' - - name: detectLanguage() - uid: word!Word.Document#detectLanguage:member(1) + - name: presentIt() + uid: word!Word.Document#presentIt:member(1) package: word! - fullName: detectLanguage() - summary: Analyzes the document text to determine the language. + fullName: presentIt() + summary: Opens PowerPoint with the Word document loaded. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -991,613 +4634,547 @@ methods: isPreview: true isDeprecated: false syntax: - content: 'detectLanguage(): void;' + content: 'presentIt(): void;' return: type: void description: '' - - name: getAnnotationById(id) - uid: word!Word.Document#getAnnotationById:member(1) + - name: printOut(options) + uid: word!Word.Document#printOut:member(1) package: word! - fullName: getAnnotationById(id) - summary: >- - Gets the annotation by ID. Throws an `ItemNotFound` error if annotation - isn't found. + fullName: printOut(options) + summary: Prints all or part of the document. remarks: >- - \[ [API set: WordApi - 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getAnnotationById(id: string): Word.Annotation;' + content: 'printOut(options?: Word.DocumentPrintOutOptions): void;' parameters: - - id: id - description: The ID of the annotation to get. - type: string + - id: options + description: Optional. Configuration options for the print operation. + type: return: - type: + type: void description: '' - - name: getBookmarkRange(name) - uid: word!Word.Document#getBookmarkRange:member(1) + - name: printPreview() + uid: word!Word.Document#printPreview:member(1) package: word! - fullName: getBookmarkRange(name) - summary: >- - Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark - doesn't exist. + fullName: printPreview() + summary: Switches the view to print preview. remarks: >- - \[ [API set: WordApi - 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getBookmarkRange(name: string): Word.Range;' - parameters: - - id: name - description: Required. The case-insensitive bookmark name. - type: string + content: 'printPreview(): void;' return: - type: + type: void description: '' - - name: getBookmarkRangeOrNullObject(name) - uid: word!Word.Document#getBookmarkRangeOrNullObject:member(1) + - name: protect(type, options) + uid: word!Word.Document#protect:member(1) package: word! - fullName: getBookmarkRangeOrNullObject(name) - summary: >- - Gets a bookmark's range. If the bookmark doesn't exist, 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). + fullName: protect(type, options) + summary: Protects the document from unauthorized changes. remarks: >- - \[ [API set: WordApi - 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getBookmarkRangeOrNullObject(name: string): Word.Range;' + content: >- + protect(type: Word.ProtectionType, options?: + Word.DocumentProtectOptions): void; parameters: - - id: name - description: Required. The case-insensitive bookmark name. - type: string + - id: type + description: The type of protection. + type: + - id: options + description: Optional. Configuration options for document protection. + type: return: - type: + type: void description: '' - - name: getContentControls(options) - uid: word!Word.Document#getContentControls:member(1) + - name: protect(type, options) + uid: word!Word.Document#protect:member(2) package: word! - fullName: getContentControls(options) - summary: Gets the currently supported content controls in the document. + fullName: protect(type, options) + summary: Protects the document from unauthorized changes. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - Important: If specific types are provided in the options parameter, only - content controls of supported types are returned. Be aware that an - exception will be thrown on using methods of a generic - [Word.ContentControl](xref:word!Word.ContentControl:class) that aren't - relevant for the specific type. With time, additional types of content - controls may be supported. Therefore, your add-in should request and - handle specific types of content controls. - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml - - - // Toggles the isChecked property on all checkbox content controls. - - await Word.run(async (context) => { - let contentControls = context.document.getContentControls({ - types: [Word.ContentControlType.checkBox] - }); - contentControls.load("items"); - - await context.sync(); - - const length = contentControls.items.length; - console.log(`Number of checkbox content controls: ${length}`); - - if (length <= 0) { - return; - } - - const checkboxContentControls = []; - for (let i = 0; i < length; i++) { - let contentControl = contentControls.items[i]; - contentControl.load("id,checkboxContentControl/isChecked"); - checkboxContentControls.push(contentControl); - } - - await context.sync(); - - console.log("isChecked state before:"); - const updatedCheckboxContentControls = []; - for (let i = 0; i < checkboxContentControls.length; i++) { - const currentCheckboxContentControl = checkboxContentControls[i]; - const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked; - console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`); - - currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore; - currentCheckboxContentControl.load("id,checkboxContentControl/isChecked"); - updatedCheckboxContentControls.push(currentCheckboxContentControl); - } - - await context.sync(); - - console.log("isChecked state after:"); - for (let i = 0; i < updatedCheckboxContentControls.length; i++) { - const currentCheckboxContentControl = updatedCheckboxContentControls[i]; - console.log( - `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}` - ); - } - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: content: >- - getContentControls(options?: Word.ContentControlOptions): - Word.ContentControlCollection; + protect(type: "NoProtection" | "AllowOnlyRevisions" | + "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", + options?: Word.DocumentProtectOptions): void; parameters: + - id: type + description: The type of protection. + type: >- + "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | + "AllowOnlyFormFields" | "AllowOnlyReading" - id: options - description: Optional. Options that define which content controls are returned. - type: + description: Optional. Configuration options for document protection. + type: return: - type: + type: void description: '' - - name: getEndnoteBody() - uid: word!Word.Document#getEndnoteBody:member(1) + - name: redo(times) + uid: word!Word.Document#redo:member(1) package: word! - fullName: getEndnoteBody() - summary: Gets the document's endnotes in a single body. + fullName: redo(times) + summary: Redoes the last action that was undone (reverses the `undo` method). remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getEndnoteBody(): Word.Body;' + content: 'redo(times?: number): OfficeExtension.ClientResult;' + parameters: + - id: times + description: Optional. The number of actions to redo. + type: number return: - type: + type: >- + <boolean> + description: >- + `true` if the actions were redone successfully; otherwise, `false`. + - name: rejectAllRevisions() + uid: word!Word.Document#rejectAllRevisions:member(1) + package: word! + fullName: rejectAllRevisions() + summary: Rejects all tracked changes in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rejectAllRevisions(): void;' + return: + type: void description: '' - - name: getFootnoteBody() - uid: word!Word.Document#getFootnoteBody:member(1) + - name: rejectAllRevisionsShown() + uid: word!Word.Document#rejectAllRevisionsShown:member(1) package: word! - fullName: getFootnoteBody() - summary: Gets the document's footnotes in a single body. + fullName: rejectAllRevisionsShown() + summary: Rejects all revisions in the document that are displayed on the screen. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getFootnoteBody(): Word.Body;' + content: 'rejectAllRevisionsShown(): void;' return: - type: + type: void description: '' - - name: getParagraphByUniqueLocalId(id) - uid: word!Word.Document#getParagraphByUniqueLocalId:member(1) + - name: reload() + uid: word!Word.Document#reload:member(1) package: word! - fullName: getParagraphByUniqueLocalId(id) + fullName: reload() summary: >- - Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error - if the collection is empty. + Reloads a cached document by resolving the hyperlink to the document and + downloading it. remarks: >- - \[ [API set: WordApi - 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml - - - await Word.run(async (context) => { - const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value; - const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId); - paragraph.load(); - await paragraph.context.sync(); - - console.log(paragraph); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getParagraphByUniqueLocalId(id: string): Word.Paragraph;' - parameters: - - id: id - description: >- - Required. Unique local ID in standard 8-4-4-4-12 GUID format without - curly braces. Note that the ID differs across sessions and - coauthors. - type: string + content: 'reload(): void;' return: - type: + type: void description: '' - - name: getSelection() - uid: word!Word.Document#getSelection:member(1) + - name: reloadAs(encoding) + uid: word!Word.Document#reloadAs:member(1) package: word! - fullName: getSelection() + fullName: reloadAs(encoding) summary: >- - Gets the current selection of the document. Multiple selections aren't - supported. + Reloads the document based on an HTML document, using the document + encoding. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Run a batch operation against the Word object model. - - await Word.run(async (context) => { - - const textSample = 'This is an example of the insert text method. This is a method ' + - 'which allows users to insert text into a selection. It can insert text into a ' + - 'relative location or it can overwrite the current selection. Since the ' + - 'getSelection method returns a range object, look up the range object documentation ' + - 'for everything you can do with a selection.'; - - // Create a range proxy object for the current selection. - const range = context.document.getSelection(); - - // Queue a command to insert text at the end of the selection. - range.insertText(textSample, Word.InsertLocation.end); - - // Synchronize the document state by executing the queued commands, - // and return a promise to indicate task completion. - await context.sync(); - console.log('Inserted the text at the end of the selection.'); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getSelection(): Word.Range;' + content: 'reloadAs(encoding: Word.DocumentEncoding): void;' + parameters: + - id: encoding + description: The encoding to use. + type: return: - type: + type: void description: '' - - name: getStyles() - uid: word!Word.Document#getStyles:member(1) + - name: reloadAs(encoding) + uid: word!Word.Document#reloadAs:member(2) package: word! - fullName: getStyles() + fullName: reloadAs(encoding) summary: >- - Gets a StyleCollection object that represents the whole style set of the - document. + Reloads the document based on an HTML document, using the document + encoding. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml - - - // Gets the number of available styles stored with the document. - - await Word.run(async (context) => { - const styles: Word.StyleCollection = context.document.getStyles(); - const count = styles.getCount(); - await context.sync(); - - console.log(`Number of styles: ${count.value}`); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'getStyles(): Word.StyleCollection;' + content: >- + reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" + | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | + "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | + "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | + "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | + "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | + "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | + "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void; + parameters: + - id: encoding + description: The encoding to use. + type: >- + "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | + "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | + "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" + | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | + "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | + "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | + "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | + "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | + "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" + | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | + "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | + "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | + "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | + "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | + "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | + "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | + "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" + | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | + "Utf7" | "Utf8" return: - type: + type: void description: '' - - name: importStylesFromJson(stylesJson, importedStylesConflictBehavior) - uid: word!Word.Document#importStylesFromJson:member(1) + - name: removeDocumentInformation(removeDocInfoType) + uid: word!Word.Document#removeDocumentInformation:member(1) package: word! - fullName: importStylesFromJson(stylesJson, importedStylesConflictBehavior) - summary: Import styles from a JSON-formatted string. + fullName: removeDocumentInformation(removeDocInfoType) + summary: >- + Removes sensitive information, properties, comments, and other metadata + from the document. remarks: >- - \[ [API set: WordApi - 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - Note: The `importedStylesConflictBehavior` parameter was introduced in - WordApiDesktop 1.1. - - - #### Examples - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml - - - // Imports styles from JSON. - - await Word.run(async (context) => { - const str = - '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}'; - const styles = context.document.importStylesFromJson(str); - - // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default. - ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore); - - await context.sync(); - console.log("Styles imported from JSON:", styles); - }); - - ``` + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: content: >- - importStylesFromJson(stylesJson: string, - importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): - OfficeExtension.ClientResult; + removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): + void; parameters: - - id: stylesJson - description: Required. A JSON-formatted string representing the styles. - type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same - name as existing styles in the current document. - type: + - id: removeDocInfoType + description: The type of document info to remove. + type: return: - type: >- - <string[]> + type: void description: '' - - name: importStylesFromJson(stylesJson, importedStylesConflictBehavior) - uid: word!Word.Document#importStylesFromJson:member(2) + - name: removeDocumentInformation(removeDocInfoType) + uid: word!Word.Document#removeDocumentInformation:member(2) package: word! - fullName: importStylesFromJson(stylesJson, importedStylesConflictBehavior) - summary: Import styles from a JSON-formatted string. + fullName: removeDocumentInformation(removeDocInfoType) + summary: >- + Removes sensitive information, properties, comments, and other metadata + from the document. remarks: >- - \[ [API set: WordApi - 1.6](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - Note: The `importedStylesConflictBehavior` parameter was introduced in - WordApiDesktop 1.1. + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: content: >- - importStylesFromJson(stylesJson: string, - importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): - OfficeExtension.ClientResult; + removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | + "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" + | "SendForReview" | "DocumentProperties" | "Template" | + "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | + "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | + "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | + "CommentReactions" | "All"): void; parameters: - - id: stylesJson - description: Required. A JSON-formatted string representing the styles. - type: string - - id: importedStylesConflictBehavior - description: >- - Optional. Specifies how to handle any imported styles with the same - name as existing styles in the current document. - type: '"Ignore" | "Overwrite" | "CreateNew"' + - id: removeDocInfoType + description: The type of document info to remove. + type: >- + "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" + | "EmailHeader" | "RoutingSlip" | "SendForReview" | + "DocumentProperties" | "Template" | "DocumentWorkspace" | + "InkAnnotations" | "DocumentServerProperties" | + "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" + | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | + "CommentReactions" | "All" return: - type: >- - <string[]> + type: void description: '' - - name: insertFileFromBase64(base64File, insertLocation, insertFileOptions) - uid: word!Word.Document#insertFileFromBase64:member(1) + - name: removeLockedStyles() + uid: word!Word.Document#removeLockedStyles:member(1) package: word! - fullName: insertFileFromBase64(base64File, insertLocation, insertFileOptions) + fullName: removeLockedStyles() summary: >- - Inserts a document into the target document at a specific location with - additional properties. Headers, footers, watermarks, and other section - properties are copied by default. + Purges the document of locked styles when formatting restrictions have + been applied in the document. remarks: >- - \[ [API set: WordApi - 1.5](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - 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 - - - ```TypeScript - - // Link to full sample: - https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml - - - // Inserts content (applying selected settings) from another document - passed in as a Base64-encoded string. + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - await Word.run(async (context) => { - // Use the Base64-encoded string representation of the selected .docx file. - context.document.insertFileFromBase64(externalDocument, "Replace", { - importTheme: true, - importStyles: true, - importParagraphSpacing: true, - importPageColor: true, - importChangeTrackingMode: true, - importCustomProperties: true, - importCustomXmlParts: true, - importDifferentOddEvenPages: true - }); - await context.sync(); - }); + isPreview: true + isDeprecated: false + syntax: + content: 'removeLockedStyles(): void;' + return: + type: void + description: '' + - name: removeNumbers(numberType) + uid: word!Word.Document#removeNumbers:member(1) + package: word! + fullName: removeNumbers(numberType) + summary: Removes numbers or bullets from the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - ``` + isPreview: true + isDeprecated: false + syntax: + content: 'removeNumbers(numberType?: Word.NumberType): void;' + parameters: + - id: numberType + description: Optional. The type of numbering to remove. + type: + return: + type: void + description: '' + - name: removeNumbers(numberType) + uid: word!Word.Document#removeNumbers:member(2) + package: word! + fullName: removeNumbers(numberType) + summary: Removes numbers or bullets from the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: content: >- - insertFileFromBase64(base64File: string, insertLocation: - Word.InsertLocation.replace | Word.InsertLocation.start | - Word.InsertLocation.end | "Replace" | "Start" | "End", - insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): + void; parameters: - - id: base64File - description: Required. The Base64-encoded content of a .docx file. - type: string - - id: insertLocation - description: Required. The value must be 'Replace', 'Start', or 'End'. - type: >- - | | | "Replace" | "Start" | - "End" - - id: insertFileOptions - description: >- - Optional. The additional properties that should be imported to the - destination document. - type: + - id: numberType + description: Optional. The type of numbering to remove. + type: '"Paragraph" | "ListNum" | "AllNumbers"' return: - type: + type: void description: '' - - name: load(options) - uid: word!Word.Document#load:member(1) + - name: removeTheme() + uid: word!Word.Document#removeTheme:member(1) package: word! - fullName: load(options) + fullName: removeTheme() + summary: Removes the active theme from the current document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removeTheme(): void;' + return: + type: void + description: '' + - name: repaginate() + uid: word!Word.Document#repaginate:member(1) + package: word! + fullName: repaginate() + summary: Repaginates the entire document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'repaginate(): void;' + return: + type: void + description: '' + - name: replyWithChanges(options) + uid: word!Word.Document#replyWithChanges:member(1) + package: word! + fullName: replyWithChanges(options) summary: >- - Queues up a command to load the specified properties of the object. You - must call `context.sync()` before reading the properties. - remarks: '' + Sends an email message to the author of the document that has been sent + out for review, notifying them that a reviewer has completed review of the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;' + content: 'replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;' parameters: - id: options - description: Provides options for which properties of the object to load. - type: + description: Optional. Configuration options for replying with changes. + type: return: - type: - description: |- - - - #### Examples - - ```TypeScript - // Run a batch operation against the Word object model. - await Word.run(async (context) => { - - // Create a proxy object for the document. - const thisDocument = context.document; - - // Queue a command to load content control properties. - thisDocument.load('contentControls/id, contentControls/text, contentControls/tag'); - - // Synchronize the document state by executing the queued commands, - // and return a promise to indicate task completion. - await context.sync(); - if (thisDocument.contentControls.items.length !== 0) { - for (let i = 0; i < thisDocument.contentControls.items.length; i++) { - console.log(thisDocument.contentControls.items[i].id); - console.log(thisDocument.contentControls.items[i].text); - console.log(thisDocument.contentControls.items[i].tag); - } - } else { - console.log('No content controls in this document.'); - } - }); - ``` - - name: load(propertyNames) - uid: word!Word.Document#load:member(2) + type: void + description: '' + - name: resetFormFields() + uid: word!Word.Document#resetFormFields:member(1) package: word! - fullName: load(propertyNames) + fullName: resetFormFields() summary: >- - Queues up a command to load the specified properties of the object. You - must call `context.sync()` before reading the properties. - remarks: '' + Clears all form fields in the document, preparing the form to be filled in + again. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'load(propertyNames?: string | string[]): Word.Document;' - parameters: - - id: propertyNames - description: >- - A comma-delimited string or an array of strings that specify the - properties to load. - type: string | string[] + content: 'resetFormFields(): void;' return: - type: + type: void description: '' - - name: load(propertyNamesAndPaths) - uid: word!Word.Document#load:member(3) + - name: returnToLastReadPosition() + uid: word!Word.Document#returnToLastReadPosition:member(1) package: word! - fullName: load(propertyNamesAndPaths) + fullName: returnToLastReadPosition() + summary: Returns the document to the last saved reading position. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'returnToLastReadPosition(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: runAutoMacro(autoMacro) + uid: word!Word.Document#runAutoMacro:member(1) + package: word! + fullName: runAutoMacro(autoMacro) summary: >- - Queues up a command to load the specified properties of the object. You - must call `context.sync()` before reading the properties. - remarks: '' + Runs an auto macro that's stored in the document. If the specified auto + macro doesn't exist, nothing happens. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: |- - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Document; + content: 'runAutoMacro(autoMacro: Word.AutoMacro): void;' 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; - } + - id: autoMacro + description: The auto macro to run. + type: return: - type: + type: void description: '' - - name: manualHyphenation() - uid: word!Word.Document#manualHyphenation:member(1) + - name: runAutoMacro(autoMacro) + uid: word!Word.Document#runAutoMacro:member(2) package: word! - fullName: manualHyphenation() - summary: Initiates manual hyphenation of a document, one line at a time. + fullName: runAutoMacro(autoMacro) + summary: >- + Runs an auto macro that's stored in the document. If the specified auto + macro doesn't exist, nothing happens. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -1605,7 +5182,13 @@ methods: isPreview: true isDeprecated: false syntax: - content: 'manualHyphenation(): void;' + content: >- + runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" + | "Sync"): void; + parameters: + - id: autoMacro + description: The auto macro to run. + type: '"StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"' return: type: void description: '' @@ -1672,99 +5255,373 @@ methods: await context.sync(); }); - ``` + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;' + parameters: + - id: saveBehavior + description: >- + Optional. The save behavior must be 'Save' or 'Prompt'. Default + value is 'Save'. + type: + - id: fileName + description: >- + Optional. The file name (exclude file extension). Only takes effect + for a new document. + type: string + return: + type: void + description: '' + - name: save(saveBehavior, fileName) + uid: word!Word.Document#save:member(2) + package: word! + fullName: save(saveBehavior, fileName) + summary: Saves the document. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + Note: The `saveBehavior` and `fileName` parameters were introduced in + WordApi 1.5. + + isPreview: false + isDeprecated: false + syntax: + content: 'save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;' + parameters: + - id: saveBehavior + description: >- + Optional. The save behavior must be 'Save' or 'Prompt'. Default + value is 'Save'. + type: '"Save" | "Prompt"' + - id: fileName + description: >- + Optional. The file name (exclude file extension). Only takes effect + for a new document. + type: string + return: + type: void + description: '' + - name: saveAsQuickStyleSet(fileName) + uid: word!Word.Document#saveAsQuickStyleSet:member(1) + package: word! + fullName: saveAsQuickStyleSet(fileName) + summary: Saves the group of quick styles currently in use. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'saveAsQuickStyleSet(fileName: string): void;' + parameters: + - id: fileName + description: The name of the file to save. + type: string + return: + type: void + description: '' + - name: search(searchText, searchOptions) + uid: word!Word.Document#search:member(1) + package: word! + fullName: search(searchText, searchOptions) + summary: >- + Performs a search with the specified search options on the scope of the + whole document. The search results are a collection of range objects. + remarks: >- + \[ [API set: WordApi + 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: |- + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + parameters: + - id: searchText + description: '' + type: string + - id: searchOptions + description: '' + type: |- + | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + } + return: + type: + description: '' + - name: select() + uid: word!Word.Document#select:member(1) + package: word! + fullName: select() + summary: Selects the contents of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: selectContentControlsByTag(tag) + uid: word!Word.Document#selectContentControlsByTag:member(1) + package: word! + fullName: selectContentControlsByTag(tag) + summary: Returns all content controls with the specified tag. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectContentControlsByTag(tag: string): Word.ContentControlCollection;' + parameters: + - id: tag + description: The tag value to filter content controls. + type: string + return: + type: + description: '' + - name: selectContentControlsByTitle(title) + uid: word!Word.Document#selectContentControlsByTitle:member(1) + package: word! + fullName: selectContentControlsByTitle(title) + summary: >- + Returns a `ContentControlCollection` object that represents all the + content controls in the document with the specified title. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectContentControlsByTitle(title: string): + Word.ContentControlCollection; + parameters: + - id: title + description: The title of the content controls. + type: string + return: + type: + description: '' + - name: selectLinkedControls(node) + uid: word!Word.Document#selectLinkedControls:member(1) + package: word! + fullName: selectLinkedControls(node) + summary: >- + Returns a `ContentControlCollection` object that represents all content + controls in the document that are linked to the specific custom XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectLinkedControls(node: Word.CustomXmlNode): + Word.ContentControlCollection; + parameters: + - id: node + description: The custom XML node. + type: + return: + type: + description: '' + - name: selectNodes(xPath, options) + uid: word!Word.Document#selectNodes:member(1) + package: word! + fullName: selectNodes(xPath, options) + summary: >- + Returns an `XmlNodeCollection` object that represents all the nodes that + match the XPath parameter in the order in which they appear in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectNodes(xPath: string, options?: Word.SelectNodesOptions): + Word.XmlNodeCollection; + parameters: + - id: xPath + description: The XPath expression. + type: string + - id: options + description: Optional. Configuration options for the nodes selection. + type: + return: + type: + description: '' + - name: selectSingleNode(xPath, options) + uid: word!Word.Document#selectSingleNode:member(1) + package: word! + fullName: selectSingleNode(xPath, options) + summary: >- + Returns an `XmlNode` object that represents the first node that matches + the XPath parameter in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): + Word.XmlNode; + parameters: + - id: xPath + description: The XPath expression. + type: string + - id: options + description: Optional. Configuration options for the node selection. + type: + return: + type: + description: '' + - name: selectUnlinkedControls(stream) + uid: word!Word.Document#selectUnlinkedControls:member(1) + package: word! + fullName: selectUnlinkedControls(stream) + summary: >- + Returns a `ContentControlCollection` object that represents all content + controls in the document that are not linked to an XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectUnlinkedControls(stream?: Word.CustomXmlPart): + Word.ContentControlCollection; + parameters: + - id: stream + description: Optional. The custom XML part. + type: + return: + type: + description: '' + - name: sendFax(address, subject) + uid: word!Word.Document#sendFax:member(1) + package: word! + fullName: sendFax(address, subject) + summary: Sends the document as a fax, without any user interaction. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;' + content: 'sendFax(address: string, subject?: string): void;' parameters: - - id: saveBehavior - description: >- - Optional. The save behavior must be 'Save' or 'Prompt'. Default - value is 'Save'. - type: - - id: fileName - description: >- - Optional. The file name (exclude file extension). Only takes effect - for a new document. + - id: address + description: The fax address. + type: string + - id: subject + description: Optional. The subject of the fax. type: string return: type: void description: '' - - name: save(saveBehavior, fileName) - uid: word!Word.Document#save:member(2) + - name: sendFaxOverInternet(options) + uid: word!Word.Document#sendFaxOverInternet:member(1) package: word! - fullName: save(saveBehavior, fileName) - summary: Saves the document. + fullName: sendFaxOverInternet(options) + summary: >- + Sends the document to a fax service provider, who faxes the document to + one or more specified recipients. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - - Note: The `saveBehavior` and `fileName` parameters were introduced in - WordApi 1.5. + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;' + content: >- + sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): + void; parameters: - - id: saveBehavior - description: >- - Optional. The save behavior must be 'Save' or 'Prompt'. Default - value is 'Save'. - type: '"Save" | "Prompt"' - - id: fileName + - id: options description: >- - Optional. The file name (exclude file extension). Only takes effect - for a new document. - type: string + Optional. Configuration options for sending the fax over the + internet. + type: >- + return: type: void description: '' - - name: search(searchText, searchOptions) - uid: word!Word.Document#search:member(1) + - name: sendForReview(options) + uid: word!Word.Document#sendForReview:member(1) package: word! - fullName: search(searchText, searchOptions) + fullName: sendForReview(options) summary: >- - Performs a search with the specified search options on the scope of the - whole document. The search results are a collection of range objects. + Sends the document in an email message for review by the specified + recipients. remarks: >- - \[ [API set: WordApi - 1.7](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: |- - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + content: 'sendForReview(options?: Word.DocumentSendForReviewOptions): void;' parameters: - - id: searchText - description: '' - type: string - - id: searchOptions - description: '' - type: |- - | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - } + - id: options + description: Optional. Configuration options for sending the document for review. + type: return: - type: + type: void + description: '' + - name: sendMail() + uid: word!Word.Document#sendMail:member(1) + package: word! + fullName: sendMail() + summary: >- + Opens a message window for sending the document through Microsoft + Exchange. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sendMail(): void;' + return: + type: void description: '' - name: set(properties, options) uid: word!Word.Document#set:member(1) @@ -1817,6 +5674,85 @@ methods: return: type: void description: '' + - name: setDefaultTableStyle(style, setInTemplate) + uid: word!Word.Document#setDefaultTableStyle:member(1) + package: word! + fullName: setDefaultTableStyle(style, setInTemplate) + summary: Specifies the table style to use for newly created tables in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setDefaultTableStyle(style: string, setInTemplate: boolean): void;' + parameters: + - id: style + description: The style to apply. + type: string + - id: setInTemplate + description: Whether to set the style in the template. + type: boolean + return: + type: void + description: '' + - name: >- + setPasswordEncryptionOptions(passwordEncryptionProvider, + passwordEncryptionAlgorithm, passwordEncryptionKeyLength, + passwordEncryptFileProperties) + uid: word!Word.Document#setPasswordEncryptionOptions:member(1) + package: word! + fullName: >- + setPasswordEncryptionOptions(passwordEncryptionProvider, + passwordEncryptionAlgorithm, passwordEncryptionKeyLength, + passwordEncryptFileProperties) + summary: >- + Sets the options Microsoft Word uses for encrypting documents with + passwords. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setPasswordEncryptionOptions(passwordEncryptionProvider: string, + passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: + number, passwordEncryptFileProperties?: boolean): void; + parameters: + - id: passwordEncryptionProvider + description: The encryption provider. + type: string + - id: passwordEncryptionAlgorithm + description: The encryption algorithm. + type: string + - id: passwordEncryptionKeyLength + description: The key length. + type: number + - id: passwordEncryptFileProperties + description: Optional. Whether to encrypt file properties. + type: boolean + return: + type: void + description: '' + - name: toggleFormsDesign() + uid: word!Word.Document#toggleFormsDesign:member(1) + package: word! + fullName: toggleFormsDesign() + summary: Switches form design mode on or off. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'toggleFormsDesign(): void;' + return: + type: void + description: '' - name: toJSON() uid: word!Word.Document#toJSON:member(1) package: word! @@ -1861,6 +5797,93 @@ methods: return: type: description: '' + - name: transformDocument(path, dataOnly) + uid: word!Word.Document#transformDocument:member(1) + package: word! + fullName: transformDocument(path, dataOnly) + summary: >- + Applies the specified Extensible Stylesheet Language Transformation (XSLT) + file to this document and replaces the document with the results. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'transformDocument(path: string, dataOnly?: boolean): void;' + parameters: + - id: path + description: The path to the XSLT file. + type: string + - id: dataOnly + description: Optional. Whether to use data only. + type: boolean + return: + type: void + description: '' + - name: undo(times) + uid: word!Word.Document#undo:member(1) + package: word! + fullName: undo(times) + summary: >- + Undoes the last action or a sequence of actions, which are displayed in + the Undo list. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'undo(times?: number): OfficeExtension.ClientResult;' + parameters: + - id: times + description: Optional. The number of actions to undo. + type: number + return: + type: >- + <boolean> + description: >- + `true` if the actions were undone successfully; otherwise, `false`. + - name: undoClear() + uid: word!Word.Document#undoClear:member(1) + package: word! + fullName: undoClear() + summary: Clears the list of actions that can be undone in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'undoClear(): void;' + return: + type: void + description: '' + - name: unprotect(password) + uid: word!Word.Document#unprotect:member(1) + package: word! + fullName: unprotect(password) + summary: Removes protection from the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'unprotect(password?: string): void;' + parameters: + - id: password + description: Optional. The password to unprotect the document. + type: string + return: + type: void + description: '' - name: untrack() uid: word!Word.Document#untrack:member(1) package: word! @@ -1882,6 +5905,78 @@ methods: return: type: description: '' + - name: updateStyles() + uid: word!Word.Document#updateStyles:member(1) + package: word! + fullName: updateStyles() + summary: >- + Copies all styles from the attached template into the document, + overwriting any existing styles in the document that have the same name. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'updateStyles(): void;' + return: + type: void + description: '' + - name: viewCode() + uid: word!Word.Document#viewCode:member(1) + package: word! + fullName: viewCode() + summary: >- + Displays the code window for the selected Microsoft ActiveX control in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'viewCode(): void;' + return: + type: void + description: '' + - name: viewPropertyBrowser() + uid: word!Word.Document#viewPropertyBrowser:member(1) + package: word! + fullName: viewPropertyBrowser() + summary: >- + Displays the property window for the selected Microsoft ActiveX control in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'viewPropertyBrowser(): void;' + return: + type: void + description: '' + - name: webPagePreview() + uid: word!Word.Document#webPagePreview:member(1) + package: word! + fullName: webPagePreview() + summary: >- + Displays a preview of the current document as it would look if saved as a + webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'webPagePreview(): void;' + return: + type: void + description: '' events: - name: onAnnotationClicked uid: word!Word.Document#onAnnotationClicked:member diff --git a/docs/docs-ref-autogen/word/word/word.documentcheckinoptions.yml b/docs/docs-ref-autogen/word/word/word.documentcheckinoptions.yml new file mode 100644 index 0000000000..46c3a2ecf8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentcheckinoptions.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Word.DocumentCheckInOptions +uid: word!Word.DocumentCheckInOptions:interface +package: word! +fullName: Word.DocumentCheckInOptions +summary: >- + Provides configuration options for the + [Document.checkIn](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: comment + uid: word!Word.DocumentCheckInOptions#comment:member + package: word! + fullName: comment + summary: If provided, specifies a comment for the check-in operation. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'comment?: string;' + return: + type: string + - name: makePublic + uid: word!Word.DocumentCheckInOptions#makePublic:member + package: word! + fullName: makePublic + summary: >- + If provided, specifies whether to make the document public after check-in. + The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'makePublic?: boolean;' + return: + type: boolean + - name: saveChanges + uid: word!Word.DocumentCheckInOptions#saveChanges:member + package: word! + fullName: saveChanges + summary: >- + If provided, specifies whether to save changes before checking in. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'saveChanges?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentcheckinwithversionoptions.yml b/docs/docs-ref-autogen/word/word/word.documentcheckinwithversionoptions.yml new file mode 100644 index 0000000000..2f1db7df85 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentcheckinwithversionoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Word.DocumentCheckInWithVersionOptions +uid: word!Word.DocumentCheckInWithVersionOptions:interface +package: word! +fullName: Word.DocumentCheckInWithVersionOptions +summary: >- + Provides configuration options for the + [Document.checkInWithVersion](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: comment + uid: word!Word.DocumentCheckInWithVersionOptions#comment:member + package: word! + fullName: comment + summary: If provided, specifies a comment for the check-in operation. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'comment?: string;' + return: + type: string + - name: makePublic + uid: word!Word.DocumentCheckInWithVersionOptions#makePublic:member + package: word! + fullName: makePublic + summary: >- + If provided, specifies whether to make the document public after check-in. + The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'makePublic?: boolean;' + return: + type: boolean + - name: saveChanges + uid: word!Word.DocumentCheckInWithVersionOptions#saveChanges:member + package: word! + fullName: saveChanges + summary: >- + If provided, specifies whether to save changes before checking in. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'saveChanges?: boolean;' + return: + type: boolean + - name: versionType + uid: word!Word.DocumentCheckInWithVersionOptions#versionType:member + package: word! + fullName: versionType + summary: >- + If provided, specifies the version type for the check-in. The default + value is `minorVersion`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'versionType?: Word.CheckInVersionType | "Minor" | "Major" | "Overwrite";' + return: + type: >- + | "Minor" | "Major" | + "Overwrite" diff --git a/docs/docs-ref-autogen/word/word/word.documentcheckspellingoptions.yml b/docs/docs-ref-autogen/word/word/word.documentcheckspellingoptions.yml new file mode 100644 index 0000000000..ada2e4b209 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentcheckspellingoptions.yml @@ -0,0 +1,220 @@ +### YamlMime:TSType +name: Word.DocumentCheckSpellingOptions +uid: word!Word.DocumentCheckSpellingOptions:interface +package: word! +fullName: Word.DocumentCheckSpellingOptions +summary: >- + Provides configuration options for the + [Document.checkSpelling](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: alwaysSuggest + uid: word!Word.DocumentCheckSpellingOptions#alwaysSuggest:member + package: word! + fullName: alwaysSuggest + summary: >- + If provided, specifies whether to always suggest spelling corrections. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'alwaysSuggest?: boolean;' + return: + type: boolean + - name: customDictionary + uid: word!Word.DocumentCheckSpellingOptions#customDictionary:member + package: word! + fullName: customDictionary + summary: >- + If provided, specifies the custom dictionary to use for spell checking. + The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary?: string;' + return: + type: string + - name: customDictionary10 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary10:member + package: word! + fullName: customDictionary10 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary10?: string;' + return: + type: string + - name: customDictionary2 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary2:member + package: word! + fullName: customDictionary2 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary2?: string;' + return: + type: string + - name: customDictionary3 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary3:member + package: word! + fullName: customDictionary3 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary3?: string;' + return: + type: string + - name: customDictionary4 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary4:member + package: word! + fullName: customDictionary4 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary4?: string;' + return: + type: string + - name: customDictionary5 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary5:member + package: word! + fullName: customDictionary5 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary5?: string;' + return: + type: string + - name: customDictionary6 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary6:member + package: word! + fullName: customDictionary6 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary6?: string;' + return: + type: string + - name: customDictionary7 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary7:member + package: word! + fullName: customDictionary7 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary7?: string;' + return: + type: string + - name: customDictionary8 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary8:member + package: word! + fullName: customDictionary8 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary8?: string;' + return: + type: string + - name: customDictionary9 + uid: word!Word.DocumentCheckSpellingOptions#customDictionary9:member + package: word! + fullName: customDictionary9 + summary: >- + If provided, specifies an additional custom dictionary to use for spell + checking. The default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'customDictionary9?: string;' + return: + type: string + - name: ignoreUppercase + uid: word!Word.DocumentCheckSpellingOptions#ignoreUppercase:member + package: word! + fullName: ignoreUppercase + summary: >- + If provided, specifies whether to ignore uppercase words during spell + checking. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ignoreUppercase?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentcountnumbereditemsoptions.yml b/docs/docs-ref-autogen/word/word/word.documentcountnumbereditemsoptions.yml new file mode 100644 index 0000000000..9203f94da4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentcountnumbereditemsoptions.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: Word.DocumentCountNumberedItemsOptions +uid: word!Word.DocumentCountNumberedItemsOptions:interface +package: word! +fullName: Word.DocumentCountNumberedItemsOptions +summary: >- + Provides configuration options for the + [Document.countNumberedItems](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: level + uid: word!Word.DocumentCountNumberedItemsOptions#level:member + package: word! + fullName: level + summary: >- + If provided, specifies the level of numbering to count. If omitted, all + levels are counted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: number;' + return: + type: number + - name: numberType + uid: word!Word.DocumentCountNumberedItemsOptions#numberType:member + package: word! + fullName: numberType + summary: >- + If provided, specifies the type of numbered items to count. The default + value is `allNumbers`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers";' + return: + type: >- + | "Paragraph" | "ListNum" | + "AllNumbers" diff --git a/docs/docs-ref-autogen/word/word/word.documentencoding.yml b/docs/docs-ref-autogen/word/word/word.documentencoding.yml new file mode 100644 index 0000000000..875b931221 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentencoding.yml @@ -0,0 +1,1386 @@ +### YamlMime:TSEnum +name: Word.DocumentEncoding +uid: word!Word.DocumentEncoding:enum +package: word! +fullName: Word.DocumentEncoding +summary: Specifies the document encoding types. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: arabic + uid: word!Word.DocumentEncoding.arabic:member + package: word! + summary: >- + Arabic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Arabic"' + - name: arabicAsmo + uid: word!Word.DocumentEncoding.arabicAsmo:member + package: word! + summary: >- + Arabic ASMO encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicAsmo"' + - name: arabicAutoDetect + uid: word!Word.DocumentEncoding.arabicAutoDetect:member + package: word! + summary: >- + Arabic auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicAutoDetect"' + - name: arabicTransparentAsmo + uid: word!Word.DocumentEncoding.arabicTransparentAsmo:member + package: word! + summary: >- + Arabic Transparent ASMO encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicTransparentAsmo"' + - name: autoDetect + uid: word!Word.DocumentEncoding.autoDetect:member + package: word! + summary: >- + Auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AutoDetect"' + - name: baltic + uid: word!Word.DocumentEncoding.baltic:member + package: word! + summary: >- + Baltic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Baltic"' + - name: centralEuropean + uid: word!Word.DocumentEncoding.centralEuropean:member + package: word! + summary: >- + Central European encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CentralEuropean"' + - name: cyrillic + uid: word!Word.DocumentEncoding.cyrillic:member + package: word! + summary: >- + Cyrillic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Cyrillic"' + - name: cyrillicAutoDetect + uid: word!Word.DocumentEncoding.cyrillicAutoDetect:member + package: word! + summary: >- + Cyrillic auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CyrillicAutoDetect"' + - name: ebcdicArabic + uid: word!Word.DocumentEncoding.ebcdicArabic:member + package: word! + summary: >- + EBCDIC Arabic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicArabic"' + - name: ebcdicDenmarkNorway + uid: word!Word.DocumentEncoding.ebcdicDenmarkNorway:member + package: word! + summary: >- + EBCDIC Denmark-Norway encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicDenmarkNorway"' + - name: ebcdicFinlandSweden + uid: word!Word.DocumentEncoding.ebcdicFinlandSweden:member + package: word! + summary: >- + EBCDIC Finland-Sweden encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicFinlandSweden"' + - name: ebcdicFrance + uid: word!Word.DocumentEncoding.ebcdicFrance:member + package: word! + summary: >- + EBCDIC France encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicFrance"' + - name: ebcdicGermany + uid: word!Word.DocumentEncoding.ebcdicGermany:member + package: word! + summary: >- + EBCDIC Germany encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicGermany"' + - name: ebcdicGreek + uid: word!Word.DocumentEncoding.ebcdicGreek:member + package: word! + summary: >- + EBCDIC Greek encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicGreek"' + - name: ebcdicGreekModern + uid: word!Word.DocumentEncoding.ebcdicGreekModern:member + package: word! + summary: >- + EBCDIC Greek Modern encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicGreekModern"' + - name: ebcdicHebrew + uid: word!Word.DocumentEncoding.ebcdicHebrew:member + package: word! + summary: >- + EBCDIC Hebrew encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicHebrew"' + - name: ebcdicIcelandic + uid: word!Word.DocumentEncoding.ebcdicIcelandic:member + package: word! + summary: >- + EBCDIC Icelandic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicIcelandic"' + - name: ebcdicInternational + uid: word!Word.DocumentEncoding.ebcdicInternational:member + package: word! + summary: >- + EBCDIC International encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicInternational"' + - name: ebcdicItaly + uid: word!Word.DocumentEncoding.ebcdicItaly:member + package: word! + summary: >- + EBCDIC Italy encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicItaly"' + - name: ebcdicJapaneseKatakanaExtended + uid: word!Word.DocumentEncoding.ebcdicJapaneseKatakanaExtended:member + package: word! + summary: >- + EBCDIC Japanese Katakana Extended encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicJapaneseKatakanaExtended"' + - name: ebcdicJapaneseKatakanaExtendedAndJapanese + uid: >- + word!Word.DocumentEncoding.ebcdicJapaneseKatakanaExtendedAndJapanese:member + package: word! + summary: >- + EBCDIC Japanese Katakana Extended and Japanese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicJapaneseKatakanaExtendedAndJapanese"' + - name: ebcdicJapaneseLatinExtendedAndJapanese + uid: word!Word.DocumentEncoding.ebcdicJapaneseLatinExtendedAndJapanese:member + package: word! + summary: >- + EBCDIC Japanese Latin Extended and Japanese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicJapaneseLatinExtendedAndJapanese"' + - name: ebcdicKoreanExtended + uid: word!Word.DocumentEncoding.ebcdicKoreanExtended:member + package: word! + summary: >- + EBCDIC Korean Extended encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicKoreanExtended"' + - name: ebcdicKoreanExtendedAndKorean + uid: word!Word.DocumentEncoding.ebcdicKoreanExtendedAndKorean:member + package: word! + summary: >- + EBCDIC Korean Extended and Korean encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicKoreanExtendedAndKorean"' + - name: ebcdicLatinAmericaSpain + uid: word!Word.DocumentEncoding.ebcdicLatinAmericaSpain:member + package: word! + summary: >- + EBCDIC Latin America-Spain encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicLatinAmericaSpain"' + - name: ebcdicMultilingualRoeceLatin2 + uid: word!Word.DocumentEncoding.ebcdicMultilingualRoeceLatin2:member + package: word! + summary: >- + EBCDIC Multilingual ROECE Latin2 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicMultilingualRoeceLatin2"' + - name: ebcdicRussian + uid: word!Word.DocumentEncoding.ebcdicRussian:member + package: word! + summary: >- + EBCDIC Russian encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicRussian"' + - name: ebcdicSerbianBulgarian + uid: word!Word.DocumentEncoding.ebcdicSerbianBulgarian:member + package: word! + summary: >- + EBCDIC Serbian-Bulgarian encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicSerbianBulgarian"' + - name: ebcdicSimplifiedChineseExtendedAndSimplifiedChinese + uid: >- + word!Word.DocumentEncoding.ebcdicSimplifiedChineseExtendedAndSimplifiedChinese:member + package: word! + summary: >- + EBCDIC Simplified Chinese Extended and Simplified Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicSimplifiedChineseExtendedAndSimplifiedChinese"' + - name: ebcdicThai + uid: word!Word.DocumentEncoding.ebcdicThai:member + package: word! + summary: >- + EBCDIC Thai encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicThai"' + - name: ebcdicTurkish + uid: word!Word.DocumentEncoding.ebcdicTurkish:member + package: word! + summary: >- + EBCDIC Turkish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicTurkish"' + - name: ebcdicTurkishLatin5 + uid: word!Word.DocumentEncoding.ebcdicTurkishLatin5:member + package: word! + summary: >- + EBCDIC Turkish Latin5 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicTurkishLatin5"' + - name: ebcdicUnitedKingdom + uid: word!Word.DocumentEncoding.ebcdicUnitedKingdom:member + package: word! + summary: >- + EBCDIC United Kingdom encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicUnitedKingdom"' + - name: ebcdicUsCanada + uid: word!Word.DocumentEncoding.ebcdicUsCanada:member + package: word! + summary: >- + EBCDIC US-Canada encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicUsCanada"' + - name: ebcdicUsCanadaAndJapanese + uid: word!Word.DocumentEncoding.ebcdicUsCanadaAndJapanese:member + package: word! + summary: >- + EBCDIC US-Canada and Japanese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicUsCanadaAndJapanese"' + - name: ebcdicUsCanadaAndTraditionalChinese + uid: word!Word.DocumentEncoding.ebcdicUsCanadaAndTraditionalChinese:member + package: word! + summary: >- + EBCDIC US-Canada and Traditional Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EbcdicUsCanadaAndTraditionalChinese"' + - name: eucChineseSimplifiedChinese + uid: word!Word.DocumentEncoding.eucChineseSimplifiedChinese:member + package: word! + summary: >- + EUC Chinese Simplified Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EucChineseSimplifiedChinese"' + - name: eucJapanese + uid: word!Word.DocumentEncoding.eucJapanese:member + package: word! + summary: >- + EUC Japanese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EucJapanese"' + - name: eucKorean + uid: word!Word.DocumentEncoding.eucKorean:member + package: word! + summary: >- + EUC Korean encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EucKorean"' + - name: eucTaiwaneseTraditionalChinese + uid: word!Word.DocumentEncoding.eucTaiwaneseTraditionalChinese:member + package: word! + summary: >- + EUC Taiwanese Traditional Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EucTaiwaneseTraditionalChinese"' + - name: europa3 + uid: word!Word.DocumentEncoding.europa3:member + package: word! + summary: >- + Europa3 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Europa3"' + - name: extAlphaLowercase + uid: word!Word.DocumentEncoding.extAlphaLowercase:member + package: word! + summary: >- + Ext Alpha Lowercase encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ExtAlphaLowercase"' + - name: greek + uid: word!Word.DocumentEncoding.greek:member + package: word! + summary: >- + Greek encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Greek"' + - name: greekAutoDetect + uid: word!Word.DocumentEncoding.greekAutoDetect:member + package: word! + summary: >- + Greek auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"GreekAutoDetect"' + - name: hebrew + uid: word!Word.DocumentEncoding.hebrew:member + package: word! + summary: >- + Hebrew encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Hebrew"' + - name: hzGbSimplifiedChinese + uid: word!Word.DocumentEncoding.hzGbSimplifiedChinese:member + package: word! + summary: >- + HZ GB Simplified Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HzGbSimplifiedChinese"' + - name: ia5German + uid: word!Word.DocumentEncoding.ia5German:member + package: word! + summary: >- + IA5 German encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ia5German"' + - name: ia5Irv + uid: word!Word.DocumentEncoding.ia5Irv:member + package: word! + summary: >- + IA5 IRV encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ia5Irv"' + - name: ia5Norwegian + uid: word!Word.DocumentEncoding.ia5Norwegian:member + package: word! + summary: >- + IA5 Norwegian encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ia5Norwegian"' + - name: ia5Swedish + uid: word!Word.DocumentEncoding.ia5Swedish:member + package: word! + summary: >- + IA5 Swedish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ia5Swedish"' + - name: isciiAssamese + uid: word!Word.DocumentEncoding.isciiAssamese:member + package: word! + summary: >- + ISCII Assamese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiAssamese"' + - name: isciiBengali + uid: word!Word.DocumentEncoding.isciiBengali:member + package: word! + summary: >- + ISCII Bengali encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiBengali"' + - name: isciiDevanagari + uid: word!Word.DocumentEncoding.isciiDevanagari:member + package: word! + summary: >- + ISCII Devanagari encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiDevanagari"' + - name: isciiGujarati + uid: word!Word.DocumentEncoding.isciiGujarati:member + package: word! + summary: >- + ISCII Gujarati encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiGujarati"' + - name: isciiKannada + uid: word!Word.DocumentEncoding.isciiKannada:member + package: word! + summary: >- + ISCII Kannada encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiKannada"' + - name: isciiMalayalam + uid: word!Word.DocumentEncoding.isciiMalayalam:member + package: word! + summary: >- + ISCII Malayalam encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiMalayalam"' + - name: isciiOriya + uid: word!Word.DocumentEncoding.isciiOriya:member + package: word! + summary: >- + ISCII Oriya encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiOriya"' + - name: isciiPunjabi + uid: word!Word.DocumentEncoding.isciiPunjabi:member + package: word! + summary: >- + ISCII Punjabi encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiPunjabi"' + - name: isciiTamil + uid: word!Word.DocumentEncoding.isciiTamil:member + package: word! + summary: >- + ISCII Tamil encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiTamil"' + - name: isciiTelugu + uid: word!Word.DocumentEncoding.isciiTelugu:member + package: word! + summary: >- + ISCII Telugu encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"IsciiTelugu"' + - name: iso2022CnSimplifiedChinese + uid: word!Word.DocumentEncoding.iso2022CnSimplifiedChinese:member + package: word! + summary: >- + ISO 2022-CN Simplified Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022CnSimplifiedChinese"' + - name: iso2022CnTraditionalChinese + uid: word!Word.DocumentEncoding.iso2022CnTraditionalChinese:member + package: word! + summary: >- + ISO 2022-CN Traditional Chinese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022CnTraditionalChinese"' + - name: iso2022JpJisX02011989 + uid: word!Word.DocumentEncoding.iso2022JpJisX02011989:member + package: word! + summary: >- + ISO 2022-JP JIS X 0201-1989 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022JpJisX02011989"' + - name: iso2022JpJisX02021984 + uid: word!Word.DocumentEncoding.iso2022JpJisX02021984:member + package: word! + summary: >- + ISO 2022-JP JIS X 0202-1984 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022JpJisX02021984"' + - name: iso2022JpNoHalfwidthKatakana + uid: word!Word.DocumentEncoding.iso2022JpNoHalfwidthKatakana:member + package: word! + summary: >- + ISO 2022-JP no halfwidth katakana encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022JpNoHalfwidthKatakana"' + - name: iso2022Kr + uid: word!Word.DocumentEncoding.iso2022Kr:member + package: word! + summary: >- + ISO 2022-KR encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso2022Kr"' + - name: iso6937NonSpacingAccent + uid: word!Word.DocumentEncoding.iso6937NonSpacingAccent:member + package: word! + summary: >- + ISO 6937 Non-Spacing Accent encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso6937NonSpacingAccent"' + - name: iso885915Latin9 + uid: word!Word.DocumentEncoding.iso885915Latin9:member + package: word! + summary: >- + ISO 8859-15 Latin9 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso885915Latin9"' + - name: iso88591Latin1 + uid: word!Word.DocumentEncoding.iso88591Latin1:member + package: word! + summary: >- + ISO 8859-1 Latin1 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88591Latin1"' + - name: iso88592CentralEurope + uid: word!Word.DocumentEncoding.iso88592CentralEurope:member + package: word! + summary: >- + ISO 8859-2 Central Europe encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88592CentralEurope"' + - name: iso88593Latin3 + uid: word!Word.DocumentEncoding.iso88593Latin3:member + package: word! + summary: >- + ISO 8859-3 Latin3 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88593Latin3"' + - name: iso88594Baltic + uid: word!Word.DocumentEncoding.iso88594Baltic:member + package: word! + summary: >- + ISO 8859-4 Baltic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88594Baltic"' + - name: iso88595Cyrillic + uid: word!Word.DocumentEncoding.iso88595Cyrillic:member + package: word! + summary: >- + ISO 8859-5 Cyrillic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88595Cyrillic"' + - name: iso88596Arabic + uid: word!Word.DocumentEncoding.iso88596Arabic:member + package: word! + summary: >- + ISO 8859-6 Arabic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88596Arabic"' + - name: iso88597Greek + uid: word!Word.DocumentEncoding.iso88597Greek:member + package: word! + summary: >- + ISO 8859-7 Greek encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88597Greek"' + - name: iso88598Hebrew + uid: word!Word.DocumentEncoding.iso88598Hebrew:member + package: word! + summary: >- + ISO 8859-8 Hebrew encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88598Hebrew"' + - name: iso88598HebrewLogical + uid: word!Word.DocumentEncoding.iso88598HebrewLogical:member + package: word! + summary: >- + ISO 8859-8 Hebrew logical encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88598HebrewLogical"' + - name: iso88599Turkish + uid: word!Word.DocumentEncoding.iso88599Turkish:member + package: word! + summary: >- + ISO 8859-9 Turkish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Iso88599Turkish"' + - name: japaneseAutoDetect + uid: word!Word.DocumentEncoding.japaneseAutoDetect:member + package: word! + summary: >- + Japanese auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"JapaneseAutoDetect"' + - name: japaneseShiftJis + uid: word!Word.DocumentEncoding.japaneseShiftJis:member + package: word! + summary: >- + Japanese Shift Japanese Industrial Standards (Shift JIS) encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"JapaneseShiftJis"' + - name: koi8R + uid: word!Word.DocumentEncoding.koi8R:member + package: word! + summary: >- + KOI8-R encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Koi8R"' + - name: koi8U + uid: word!Word.DocumentEncoding.koi8U:member + package: word! + summary: >- + KOI8-U encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Koi8U"' + - name: korean + uid: word!Word.DocumentEncoding.korean:member + package: word! + summary: >- + Korean encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Korean"' + - name: koreanAutoDetect + uid: word!Word.DocumentEncoding.koreanAutoDetect:member + package: word! + summary: >- + Korean auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KoreanAutoDetect"' + - name: koreanJohab + uid: word!Word.DocumentEncoding.koreanJohab:member + package: word! + summary: >- + Korean Johab encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KoreanJohab"' + - name: macArabic + uid: word!Word.DocumentEncoding.macArabic:member + package: word! + summary: >- + Mac Arabic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacArabic"' + - name: macCroatia + uid: word!Word.DocumentEncoding.macCroatia:member + package: word! + summary: >- + Mac Croatia encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacCroatia"' + - name: macCyrillic + uid: word!Word.DocumentEncoding.macCyrillic:member + package: word! + summary: >- + Mac Cyrillic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacCyrillic"' + - name: macGreek1 + uid: word!Word.DocumentEncoding.macGreek1:member + package: word! + summary: >- + Mac Greek1 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacGreek1"' + - name: macHebrew + uid: word!Word.DocumentEncoding.macHebrew:member + package: word! + summary: >- + Mac Hebrew encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacHebrew"' + - name: macIcelandic + uid: word!Word.DocumentEncoding.macIcelandic:member + package: word! + summary: >- + Mac Icelandic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacIcelandic"' + - name: macJapanese + uid: word!Word.DocumentEncoding.macJapanese:member + package: word! + summary: >- + Mac Japanese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacJapanese"' + - name: macKorean + uid: word!Word.DocumentEncoding.macKorean:member + package: word! + summary: >- + Mac Korean encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacKorean"' + - name: macLatin2 + uid: word!Word.DocumentEncoding.macLatin2:member + package: word! + summary: >- + Mac Latin2 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacLatin2"' + - name: macRoman + uid: word!Word.DocumentEncoding.macRoman:member + package: word! + summary: >- + Mac Roman encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacRoman"' + - name: macRomania + uid: word!Word.DocumentEncoding.macRomania:member + package: word! + summary: >- + Mac Romania encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacRomania"' + - name: macSimplifiedChineseGb2312 + uid: word!Word.DocumentEncoding.macSimplifiedChineseGb2312:member + package: word! + summary: >- + Mac Simplified Chinese GB2312 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacSimplifiedChineseGb2312"' + - name: macTraditionalChineseBig5 + uid: word!Word.DocumentEncoding.macTraditionalChineseBig5:member + package: word! + summary: >- + Mac Traditional Chinese Big5 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacTraditionalChineseBig5"' + - name: macTurkish + uid: word!Word.DocumentEncoding.macTurkish:member + package: word! + summary: >- + Mac Turkish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacTurkish"' + - name: macUkraine + uid: word!Word.DocumentEncoding.macUkraine:member + package: word! + summary: >- + Mac Ukraine encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MacUkraine"' + - name: oemArabic + uid: word!Word.DocumentEncoding.oemArabic:member + package: word! + summary: >- + OEM Arabic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemArabic"' + - name: oemBaltic + uid: word!Word.DocumentEncoding.oemBaltic:member + package: word! + summary: >- + OEM Baltic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemBaltic"' + - name: oemCanadianFrench + uid: word!Word.DocumentEncoding.oemCanadianFrench:member + package: word! + summary: >- + OEM Canadian French encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemCanadianFrench"' + - name: oemCyrillic + uid: word!Word.DocumentEncoding.oemCyrillic:member + package: word! + summary: >- + OEM Cyrillic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemCyrillic"' + - name: oemCyrillicIi + uid: word!Word.DocumentEncoding.oemCyrillicIi:member + package: word! + summary: >- + OEM Cyrillic II encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemCyrillicIi"' + - name: oemGreek437G + uid: word!Word.DocumentEncoding.oemGreek437G:member + package: word! + summary: >- + OEM Greek 437G encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemGreek437G"' + - name: oemHebrew + uid: word!Word.DocumentEncoding.oemHebrew:member + package: word! + summary: >- + OEM Hebrew encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemHebrew"' + - name: oemIcelandic + uid: word!Word.DocumentEncoding.oemIcelandic:member + package: word! + summary: >- + OEM Icelandic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemIcelandic"' + - name: oemModernGreek + uid: word!Word.DocumentEncoding.oemModernGreek:member + package: word! + summary: >- + OEM Modern Greek encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemModernGreek"' + - name: oemMultilingualLatinI + uid: word!Word.DocumentEncoding.oemMultilingualLatinI:member + package: word! + summary: >- + OEM Multilingual Latin I encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemMultilingualLatinI"' + - name: oemMultilingualLatinIi + uid: word!Word.DocumentEncoding.oemMultilingualLatinIi:member + package: word! + summary: >- + OEM Multilingual Latin II encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemMultilingualLatinIi"' + - name: oemNordic + uid: word!Word.DocumentEncoding.oemNordic:member + package: word! + summary: >- + OEM Nordic encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemNordic"' + - name: oemPortuguese + uid: word!Word.DocumentEncoding.oemPortuguese:member + package: word! + summary: >- + OEM Portuguese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemPortuguese"' + - name: oemTurkish + uid: word!Word.DocumentEncoding.oemTurkish:member + package: word! + summary: >- + OEM Turkish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemTurkish"' + - name: oemUnitedStates + uid: word!Word.DocumentEncoding.oemUnitedStates:member + package: word! + summary: >- + OEM United States encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OemUnitedStates"' + - name: simplifiedChineseAutoDetect + uid: word!Word.DocumentEncoding.simplifiedChineseAutoDetect:member + package: word! + summary: >- + Simplified Chinese auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SimplifiedChineseAutoDetect"' + - name: simplifiedChineseGb18030 + uid: word!Word.DocumentEncoding.simplifiedChineseGb18030:member + package: word! + summary: >- + Simplified Chinese GB18030 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SimplifiedChineseGb18030"' + - name: simplifiedChineseGbk + uid: word!Word.DocumentEncoding.simplifiedChineseGbk:member + package: word! + summary: >- + Simplified Chinese Guojia Biaozhun Kuozhan (GBK, which means "National + Standard Extended" in Chinese) encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SimplifiedChineseGbk"' + - name: t61 + uid: word!Word.DocumentEncoding.t61:member + package: word! + summary: >- + T61 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"T61"' + - name: taiwanCns + uid: word!Word.DocumentEncoding.taiwanCns:member + package: word! + summary: >- + Taiwan CNS encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanCns"' + - name: taiwanEten + uid: word!Word.DocumentEncoding.taiwanEten:member + package: word! + summary: >- + Taiwan Eten encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanEten"' + - name: taiwanIbm5550 + uid: word!Word.DocumentEncoding.taiwanIbm5550:member + package: word! + summary: >- + Taiwan IBM5550 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanIbm5550"' + - name: taiwanTca + uid: word!Word.DocumentEncoding.taiwanTca:member + package: word! + summary: >- + Taiwan TCA encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanTca"' + - name: taiwanTeleText + uid: word!Word.DocumentEncoding.taiwanTeleText:member + package: word! + summary: >- + Taiwan TeleText encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanTeleText"' + - name: taiwanWang + uid: word!Word.DocumentEncoding.taiwanWang:member + package: word! + summary: >- + Taiwan Wang encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaiwanWang"' + - name: thai + uid: word!Word.DocumentEncoding.thai:member + package: word! + summary: >- + Thai encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Thai"' + - name: traditionalChineseAutoDetect + uid: word!Word.DocumentEncoding.traditionalChineseAutoDetect:member + package: word! + summary: >- + Traditional Chinese auto detect encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TraditionalChineseAutoDetect"' + - name: traditionalChineseBig5 + uid: word!Word.DocumentEncoding.traditionalChineseBig5:member + package: word! + summary: >- + Traditional Chinese Big5 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TraditionalChineseBig5"' + - name: turkish + uid: word!Word.DocumentEncoding.turkish:member + package: word! + summary: >- + Turkish encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Turkish"' + - name: unicodeBigEndian + uid: word!Word.DocumentEncoding.unicodeBigEndian:member + package: word! + summary: >- + Unicode Big Endian encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UnicodeBigEndian"' + - name: unicodeLittleEndian + uid: word!Word.DocumentEncoding.unicodeLittleEndian:member + package: word! + summary: >- + Unicode Little Endian encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UnicodeLittleEndian"' + - name: usaAscii + uid: word!Word.DocumentEncoding.usaAscii:member + package: word! + summary: >- + US ASCII encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UsaAscii"' + - name: utf7 + uid: word!Word.DocumentEncoding.utf7:member + package: word! + summary: >- + UTF-7 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Utf7"' + - name: utf8 + uid: word!Word.DocumentEncoding.utf8:member + package: word! + summary: >- + UTF-8 encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Utf8"' + - name: vietnamese + uid: word!Word.DocumentEncoding.vietnamese:member + package: word! + summary: >- + Vietnamese encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Vietnamese"' + - name: western + uid: word!Word.DocumentEncoding.western:member + package: word! + summary: >- + Western encoding. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Western"' diff --git a/docs/docs-ref-autogen/word/word/word.documentendreviewoptions.yml b/docs/docs-ref-autogen/word/word/word.documentendreviewoptions.yml new file mode 100644 index 0000000000..7739b1b83a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentendreviewoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Word.DocumentEndReviewOptions +uid: word!Word.DocumentEndReviewOptions:interface +package: word! +fullName: Word.DocumentEndReviewOptions +summary: >- + Provides configuration options for the + [Document.endReview](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: includeAttachment + uid: word!Word.DocumentEndReviewOptions#includeAttachment:member + package: word! + fullName: includeAttachment + summary: >- + If provided, specifies whether to include the document as an attachment. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeAttachment?: boolean;' + return: + type: boolean + - name: recipients + uid: word!Word.DocumentEndReviewOptions#recipients:member + package: word! + fullName: recipients + summary: >- + If provided, specifies the recipients to notify when ending the review. + The default value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'recipients?: string;' + return: + type: string + - name: showMessage + uid: word!Word.DocumentEndReviewOptions#showMessage:member + package: word! + fullName: showMessage + summary: >- + If provided, specifies whether to show the message before sending. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'showMessage?: boolean;' + return: + type: boolean + - name: subject + uid: word!Word.DocumentEndReviewOptions#subject:member + package: word! + fullName: subject + summary: >- + If provided, specifies the subject of the notification email. The default + value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat2options.yml b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat2options.yml new file mode 100644 index 0000000000..33527792c1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat2options.yml @@ -0,0 +1,269 @@ +### YamlMime:TSType +name: Word.DocumentExportAsFixedFormat2Options +uid: word!Word.DocumentExportAsFixedFormat2Options:interface +package: word! +fullName: Word.DocumentExportAsFixedFormat2Options +summary: >- + Represents the options for exporting a document as a fixed format (PDF or XPS) + using the [Document.exportAsFixedFormat2](xref:word!Word.Document:class) + method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bitmapMissingFonts + uid: word!Word.DocumentExportAsFixedFormat2Options#bitmapMissingFonts:member + package: word! + fullName: bitmapMissingFonts + summary: >- + If provided, specifies whether to bitmap missing fonts. The default value + is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bitmapMissingFonts?: boolean;' + return: + type: boolean + - name: createBookmarks + uid: word!Word.DocumentExportAsFixedFormat2Options#createBookmarks:member + package: word! + fullName: createBookmarks + summary: >- + If provided, specifies the bookmark creation mode. The default value is + `none`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | + "WordBookmarks"; + return: + type: >- + | "None" | + "Headings" | "WordBookmarks" + - name: documentStructureTags + uid: word!Word.DocumentExportAsFixedFormat2Options#documentStructureTags:member + package: word! + fullName: documentStructureTags + summary: >- + If provided, specifies whether to include document structure tags. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'documentStructureTags?: boolean;' + return: + type: boolean + - name: fixedFormatExtClassPtr + uid: >- + word!Word.DocumentExportAsFixedFormat2Options#fixedFormatExtClassPtr:member + package: word! + fullName: fixedFormatExtClassPtr + summary: >- + If provided, specifies the extension class pointer. The default value is + `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fixedFormatExtClassPtr?: any;' + return: + type: any + - name: from + uid: word!Word.DocumentExportAsFixedFormat2Options#from:member + package: word! + fullName: from + summary: >- + If provided, specifies the starting page number. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'from?: number;' + return: + type: number + - name: includeDocProps + uid: word!Word.DocumentExportAsFixedFormat2Options#includeDocProps:member + package: word! + fullName: includeDocProps + summary: >- + If provided, specifies whether to include document properties. The default + value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeDocProps?: boolean;' + return: + type: boolean + - name: item + uid: word!Word.DocumentExportAsFixedFormat2Options#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the item to export. The default value is + `documentContent`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";' + return: + type: >- + | "DocumentContent" | + "DocumentWithMarkup" + - name: keepInformationRightsManagement + uid: >- + word!Word.DocumentExportAsFixedFormat2Options#keepInformationRightsManagement:member + package: word! + fullName: keepInformationRightsManagement + summary: >- + If provided, specifies whether to keep Information Rights Management (IRM) + settings. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'keepInformationRightsManagement?: boolean;' + return: + type: boolean + - name: openAfterExport + uid: word!Word.DocumentExportAsFixedFormat2Options#openAfterExport:member + package: word! + fullName: openAfterExport + summary: >- + If provided, specifies whether to open the file after export. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'openAfterExport?: boolean;' + return: + type: boolean + - name: optimizeFor + uid: word!Word.DocumentExportAsFixedFormat2Options#optimizeFor:member + package: word! + fullName: optimizeFor + summary: >- + If provided, specifies the optimization target for the export. The default + value is `print`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";' + return: + type: | "Print" | "OnScreen" + - name: optimizeForImageQuality + uid: >- + word!Word.DocumentExportAsFixedFormat2Options#optimizeForImageQuality:member + package: word! + fullName: optimizeForImageQuality + summary: >- + If provided, specifies whether to optimize for image quality in the + exported file. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'optimizeForImageQuality?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.DocumentExportAsFixedFormat2Options#range:member + package: word! + fullName: range + summary: >- + If provided, specifies the range to export. The default value is + `allDocument`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | + "FromTo"; + return: + type: >- + | "AllDocument" | + "Selection" | "CurrentPage" | "FromTo" + - name: to + uid: word!Word.DocumentExportAsFixedFormat2Options#to:member + package: word! + fullName: to + summary: >- + If provided, specifies the ending page number. The default value is the + last page of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'to?: number;' + return: + type: number + - name: useIso19005_1 + uid: word!Word.DocumentExportAsFixedFormat2Options#useIso19005_1:member + package: word! + fullName: useIso19005_1 + summary: >- + If provided, specifies whether to use [ISO 19005-1 + compliance](https://www.iso.org/standard/38920.html). The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useIso19005_1?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat3options.yml b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat3options.yml new file mode 100644 index 0000000000..1e51cdd42f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformat3options.yml @@ -0,0 +1,286 @@ +### YamlMime:TSType +name: Word.DocumentExportAsFixedFormat3Options +uid: word!Word.DocumentExportAsFixedFormat3Options:interface +package: word! +fullName: Word.DocumentExportAsFixedFormat3Options +summary: >- + Represents the options for exporting a document as a fixed format (PDF or XPS) + with improved tagging using the + [Document.exportAsFixedFormat3](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bitmapMissingFonts + uid: word!Word.DocumentExportAsFixedFormat3Options#bitmapMissingFonts:member + package: word! + fullName: bitmapMissingFonts + summary: >- + If provided, specifies whether to bitmap missing fonts. The default value + is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bitmapMissingFonts?: boolean;' + return: + type: boolean + - name: createBookmarks + uid: word!Word.DocumentExportAsFixedFormat3Options#createBookmarks:member + package: word! + fullName: createBookmarks + summary: >- + If provided, specifies the bookmark creation mode. The default value is + `none`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | + "WordBookmarks"; + return: + type: >- + | "None" | + "Headings" | "WordBookmarks" + - name: documentStructureTags + uid: word!Word.DocumentExportAsFixedFormat3Options#documentStructureTags:member + package: word! + fullName: documentStructureTags + summary: >- + If provided, specifies whether to include document structure tags. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'documentStructureTags?: boolean;' + return: + type: boolean + - name: fixedFormatExtClassPtr + uid: >- + word!Word.DocumentExportAsFixedFormat3Options#fixedFormatExtClassPtr:member + package: word! + fullName: fixedFormatExtClassPtr + summary: >- + If provided, specifies the extension class pointer. The default value is + `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fixedFormatExtClassPtr?: any;' + return: + type: any + - name: from + uid: word!Word.DocumentExportAsFixedFormat3Options#from:member + package: word! + fullName: from + summary: >- + If provided, specifies the starting page number. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'from?: number;' + return: + type: number + - name: improveExportTagging + uid: word!Word.DocumentExportAsFixedFormat3Options#improveExportTagging:member + package: word! + fullName: improveExportTagging + summary: >- + If provided, specifies to improve export tagging for better accessibility. + The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'improveExportTagging?: boolean;' + return: + type: boolean + - name: includeDocProps + uid: word!Word.DocumentExportAsFixedFormat3Options#includeDocProps:member + package: word! + fullName: includeDocProps + summary: >- + If provided, specifies whether to include document properties. The default + value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeDocProps?: boolean;' + return: + type: boolean + - name: item + uid: word!Word.DocumentExportAsFixedFormat3Options#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the item to export. The default value is + `documentContent`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";' + return: + type: >- + | "DocumentContent" | + "DocumentWithMarkup" + - name: keepInformationRightsManagement + uid: >- + word!Word.DocumentExportAsFixedFormat3Options#keepInformationRightsManagement:member + package: word! + fullName: keepInformationRightsManagement + summary: >- + If provided, specifies whether to keep Information Rights Management (IRM) + settings. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'keepInformationRightsManagement?: boolean;' + return: + type: boolean + - name: openAfterExport + uid: word!Word.DocumentExportAsFixedFormat3Options#openAfterExport:member + package: word! + fullName: openAfterExport + summary: >- + If provided, specifies whether to open the file after export. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'openAfterExport?: boolean;' + return: + type: boolean + - name: optimizeFor + uid: word!Word.DocumentExportAsFixedFormat3Options#optimizeFor:member + package: word! + fullName: optimizeFor + summary: >- + If provided, specifies the optimization target for the export. The default + value is `print`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";' + return: + type: | "Print" | "OnScreen" + - name: optimizeForImageQuality + uid: >- + word!Word.DocumentExportAsFixedFormat3Options#optimizeForImageQuality:member + package: word! + fullName: optimizeForImageQuality + summary: >- + If provided, specifies whether to optimize for image quality in the + exported file. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'optimizeForImageQuality?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.DocumentExportAsFixedFormat3Options#range:member + package: word! + fullName: range + summary: >- + If provided, specifies the range to export. The default value is + `allDocument`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | + "FromTo"; + return: + type: >- + | "AllDocument" | + "Selection" | "CurrentPage" | "FromTo" + - name: to + uid: word!Word.DocumentExportAsFixedFormat3Options#to:member + package: word! + fullName: to + summary: >- + If provided, specifies the ending page number. The default value is the + last page of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'to?: number;' + return: + type: number + - name: useIso19005_1 + uid: word!Word.DocumentExportAsFixedFormat3Options#useIso19005_1:member + package: word! + fullName: useIso19005_1 + summary: >- + If provided, specifies whether to use [ISO 19005-1 + compliance](https://www.iso.org/standard/38920.html). The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useIso19005_1?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentexportasfixedformatoptions.yml b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformatoptions.yml new file mode 100644 index 0000000000..f5878e2c73 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentexportasfixedformatoptions.yml @@ -0,0 +1,250 @@ +### YamlMime:TSType +name: Word.DocumentExportAsFixedFormatOptions +uid: word!Word.DocumentExportAsFixedFormatOptions:interface +package: word! +fullName: Word.DocumentExportAsFixedFormatOptions +summary: >- + Provides configuration options for the + [Document.exportAsFixedFormat](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bitmapMissingFonts + uid: word!Word.DocumentExportAsFixedFormatOptions#bitmapMissingFonts:member + package: word! + fullName: bitmapMissingFonts + summary: >- + If provided, specifies whether to bitmap missing fonts. The default value + is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bitmapMissingFonts?: boolean;' + return: + type: boolean + - name: createBookmarks + uid: word!Word.DocumentExportAsFixedFormatOptions#createBookmarks:member + package: word! + fullName: createBookmarks + summary: >- + If provided, specifies the bookmark creation mode. The default value is + `none`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | + "WordBookmarks"; + return: + type: >- + | "None" | + "Headings" | "WordBookmarks" + - name: documentStructureTags + uid: word!Word.DocumentExportAsFixedFormatOptions#documentStructureTags:member + package: word! + fullName: documentStructureTags + summary: >- + If provided, specifies whether to include document structure tags. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'documentStructureTags?: boolean;' + return: + type: boolean + - name: fixedFormatExtensionClassPointer + uid: >- + word!Word.DocumentExportAsFixedFormatOptions#fixedFormatExtensionClassPointer:member + package: word! + fullName: fixedFormatExtensionClassPointer + summary: >- + If provided, specifies the extension class pointer. The default value is + `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fixedFormatExtensionClassPointer?: any;' + return: + type: any + - name: from + uid: word!Word.DocumentExportAsFixedFormatOptions#from:member + package: word! + fullName: from + summary: >- + If provided, specifies the starting page number. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'from?: number;' + return: + type: number + - name: includeDocProps + uid: word!Word.DocumentExportAsFixedFormatOptions#includeDocProps:member + package: word! + fullName: includeDocProps + summary: >- + If provided, specifies whether to include document properties. The default + value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeDocProps?: boolean;' + return: + type: boolean + - name: item + uid: word!Word.DocumentExportAsFixedFormatOptions#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the item to export. The default value is + `documentContent`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup";' + return: + type: >- + | "DocumentContent" | + "DocumentWithMarkup" + - name: keepInformationRightsManagement + uid: >- + word!Word.DocumentExportAsFixedFormatOptions#keepInformationRightsManagement:member + package: word! + fullName: keepInformationRightsManagement + summary: >- + If provided, specifies whether to keep Information Rights Management (IRM) + settings. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'keepInformationRightsManagement?: boolean;' + return: + type: boolean + - name: openAfterExport + uid: word!Word.DocumentExportAsFixedFormatOptions#openAfterExport:member + package: word! + fullName: openAfterExport + summary: >- + If provided, specifies whether to open the file after export. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'openAfterExport?: boolean;' + return: + type: boolean + - name: optimizeFor + uid: word!Word.DocumentExportAsFixedFormatOptions#optimizeFor:member + package: word! + fullName: optimizeFor + summary: >- + If provided, specifies the optimization target for the export. The default + value is `print`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen";' + return: + type: | "Print" | "OnScreen" + - name: range + uid: word!Word.DocumentExportAsFixedFormatOptions#range:member + package: word! + fullName: range + summary: >- + If provided, specifies the range to export. The default value is + `allDocument`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | + "FromTo"; + return: + type: >- + | "AllDocument" | + "Selection" | "CurrentPage" | "FromTo" + - name: to + uid: word!Word.DocumentExportAsFixedFormatOptions#to:member + package: word! + fullName: to + summary: >- + If provided, specifies the ending page number. The default value is the + last page of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'to?: number;' + return: + type: number + - name: useIso19005_1 + uid: word!Word.DocumentExportAsFixedFormatOptions#useIso19005_1:member + package: word! + fullName: useIso19005_1 + summary: >- + If provided, specifies whether to use [ISO 19005-1 + compliance](https://www.iso.org/standard/38920.html). The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useIso19005_1?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentfollowhyperlinkoptions.yml b/docs/docs-ref-autogen/word/word/word.documentfollowhyperlinkoptions.yml new file mode 100644 index 0000000000..61d6f53019 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentfollowhyperlinkoptions.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: Word.DocumentFollowHyperlinkOptions +uid: word!Word.DocumentFollowHyperlinkOptions:interface +package: word! +fullName: Word.DocumentFollowHyperlinkOptions +summary: >- + Provides configuration options for the + [Document.followHyperlink](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: addHistory + uid: word!Word.DocumentFollowHyperlinkOptions#addHistory:member + package: word! + fullName: addHistory + summary: >- + If provided, specifies whether to add the link to the browsing history. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addHistory?: boolean;' + return: + type: boolean + - name: address + uid: word!Word.DocumentFollowHyperlinkOptions#address:member + package: word! + fullName: address + summary: >- + If provided, specifies the hyperlink address to follow. The default value + is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'address?: string;' + return: + type: string + - name: extraInfo + uid: word!Word.DocumentFollowHyperlinkOptions#extraInfo:member + package: word! + fullName: extraInfo + summary: >- + If provided, specifies additional information to pass with the request. + The default value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'extraInfo?: string;' + return: + type: string + - name: headerInfo + uid: word!Word.DocumentFollowHyperlinkOptions#headerInfo:member + package: word! + fullName: headerInfo + summary: >- + If provided, specifies header information for the HTTP request. The + default value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'headerInfo?: string;' + return: + type: string + - name: httpMethod + uid: word!Word.DocumentFollowHyperlinkOptions#httpMethod:member + package: word! + fullName: httpMethod + summary: >- + If provided, specifies the HTTP method to use for the request. The default + value is "GET". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'httpMethod?: string;' + return: + type: string + - name: newWindow + uid: word!Word.DocumentFollowHyperlinkOptions#newWindow:member + package: word! + fullName: newWindow + summary: >- + If provided, specifies whether to open the link in a new window. The + default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'newWindow?: boolean;' + return: + type: boolean + - name: subAddress + uid: word!Word.DocumentFollowHyperlinkOptions#subAddress:member + package: word! + fullName: subAddress + summary: >- + If provided, specifies the sub-address within the document. The default + value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'subAddress?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.documentkind.yml b/docs/docs-ref-autogen/word/word/word.documentkind.yml new file mode 100644 index 0000000000..90ebaaecac --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentkind.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.DocumentKind +uid: word!Word.DocumentKind:enum +package: word! +fullName: Word.DocumentKind +summary: Specifies the kind or purpose of a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: email + uid: word!Word.DocumentKind.email:member + package: word! + summary: >- + Represents an email document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Email"' + - name: letter + uid: word!Word.DocumentKind.letter:member + package: word! + summary: >- + Represents a letter document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Letter"' + - name: notSpecified + uid: word!Word.DocumentKind.notSpecified:member + package: word! + summary: >- + Represents a document with no specified kind. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NotSpecified"' diff --git a/docs/docs-ref-autogen/word/word/word.documentmergeoptions.yml b/docs/docs-ref-autogen/word/word/word.documentmergeoptions.yml new file mode 100644 index 0000000000..665ceea788 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentmergeoptions.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Word.DocumentMergeOptions +uid: word!Word.DocumentMergeOptions:interface +package: word! +fullName: Word.DocumentMergeOptions +summary: >- + Provides configuration options for the + [Document.merge](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: addToRecentFiles + uid: word!Word.DocumentMergeOptions#addToRecentFiles:member + package: word! + fullName: addToRecentFiles + summary: >- + If provided, specifies whether to add the merged document to recent files. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addToRecentFiles?: boolean;' + return: + type: boolean + - name: detectFormatChanges + uid: word!Word.DocumentMergeOptions#detectFormatChanges:member + package: word! + fullName: detectFormatChanges + summary: >- + If provided, specifies whether to detect format changes during the merge. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'detectFormatChanges?: boolean;' + return: + type: boolean + - name: mergeTarget + uid: word!Word.DocumentMergeOptions#mergeTarget:member + package: word! + fullName: mergeTarget + summary: >- + If provided, specifies the target of the merge operation. The default + value is `current`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'mergeTarget?: Word.MergeTarget | "Selected" | "Current" | "New";' + return: + type: >- + | "Selected" | "Current" | + "New" + - name: useFormattingFrom + uid: word!Word.DocumentMergeOptions#useFormattingFrom:member + package: word! + fullName: useFormattingFrom + summary: >- + If provided, specifies the source of formatting to use in the merge. The + default value is `current`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + useFormattingFrom?: Word.UseFormattingFrom | "Current" | "Selected" | + "Prompt"; + return: + type: >- + | "Current" | + "Selected" | "Prompt" diff --git a/docs/docs-ref-autogen/word/word/word.documentprintoutoptions.yml b/docs/docs-ref-autogen/word/word/word.documentprintoutoptions.yml new file mode 100644 index 0000000000..b65c77af0d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentprintoutoptions.yml @@ -0,0 +1,336 @@ +### YamlMime:TSType +name: Word.DocumentPrintOutOptions +uid: word!Word.DocumentPrintOutOptions:interface +package: word! +fullName: Word.DocumentPrintOutOptions +summary: >- + Provides configuration options for the + [Document.printOut](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: activePrinterMacGX + uid: word!Word.DocumentPrintOutOptions#activePrinterMacGX:member + package: word! + fullName: activePrinterMacGX + summary: >- + If provided, specifies the printer name. The default value is an empty + string. This argument is available only in Microsoft Office Macintosh + Edition. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activePrinterMacGX?: string;' + return: + type: string + - name: append + uid: word!Word.DocumentPrintOutOptions#append:member + package: word! + fullName: append + summary: >- + If provided, specifies whether to append to an existing file. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'append?: boolean;' + return: + type: boolean + - name: background + uid: word!Word.DocumentPrintOutOptions#background:member + package: word! + fullName: background + summary: >- + If provided, specifies whether to print in the background. The default + value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'background?: boolean;' + return: + type: boolean + - name: collate + uid: word!Word.DocumentPrintOutOptions#collate:member + package: word! + fullName: collate + summary: >- + If provided, specifies whether to collate pages. The default value is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'collate?: boolean;' + return: + type: boolean + - name: copies + uid: word!Word.DocumentPrintOutOptions#copies:member + package: word! + fullName: copies + summary: >- + If provided, specifies the number of copies to print. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copies?: number;' + return: + type: number + - name: from + uid: word!Word.DocumentPrintOutOptions#from:member + package: word! + fullName: from + summary: >- + If provided, specifies the starting page number. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'from?: number;' + return: + type: number + - name: item + uid: word!Word.DocumentPrintOutOptions#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the item to print. The default value is + `PrintOutItem.documentContent`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + item?: Word.PrintOutItem | "DocumentContent" | "Properties" | "Comments" + | "Markup" | "Styles" | "AutoTextEntries" | "KeyAssignments" | + "Envelope" | "DocumentWithMarkup"; + return: + type: >- + | "DocumentContent" | + "Properties" | "Comments" | "Markup" | "Styles" | "AutoTextEntries" | + "KeyAssignments" | "Envelope" | "DocumentWithMarkup" + - name: manualDuplexPrint + uid: word!Word.DocumentPrintOutOptions#manualDuplexPrint:member + package: word! + fullName: manualDuplexPrint + summary: >- + If provided, specifies whether to manually duplex print. The default value + is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'manualDuplexPrint?: boolean;' + return: + type: boolean + - name: outputFileName + uid: word!Word.DocumentPrintOutOptions#outputFileName:member + package: word! + fullName: outputFileName + summary: >- + If provided, specifies the name of the output file. The default value is + an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'outputFileName?: string;' + return: + type: string + - name: pages + uid: word!Word.DocumentPrintOutOptions#pages:member + package: word! + fullName: pages + summary: >- + If provided, specifies specific pages to print. The default value is an + empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pages?: string;' + return: + type: string + - name: pageType + uid: word!Word.DocumentPrintOutOptions#pageType:member + package: word! + fullName: pageType + summary: >- + If provided, specifies the page order. The default value is + `PrintOutPages.allPages`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageType?: Word.PrintOutPages | "All" | "OddOnly" | "EvenOnly";' + return: + type: >- + | "All" | "OddOnly" | + "EvenOnly" + - name: printToFile + uid: word!Word.DocumentPrintOutOptions#printToFile:member + package: word! + fullName: printToFile + summary: >- + If provided, specifies whether to print to file. The default value is + `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printToFile?: boolean;' + return: + type: boolean + - name: printZoomColumn + uid: word!Word.DocumentPrintOutOptions#printZoomColumn:member + package: word! + fullName: printZoomColumn + summary: >- + If provided, specifies the zoom column setting. The default value is + `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printZoomColumn?: number;' + return: + type: number + - name: printZoomPaperHeight + uid: word!Word.DocumentPrintOutOptions#printZoomPaperHeight:member + package: word! + fullName: printZoomPaperHeight + summary: >- + If provided, specifies the paper height for printing in twips (20 twips = + 1 point; 72 points = 1 inch). The default value is `0` (use original + height). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printZoomPaperHeight?: number;' + return: + type: number + - name: printZoomPaperWidth + uid: word!Word.DocumentPrintOutOptions#printZoomPaperWidth:member + package: word! + fullName: printZoomPaperWidth + summary: >- + If provided, specifies the paper width for printing in twips (20 twips = 1 + point; 72 points = 1 inch). The default value is `0` (use original width). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printZoomPaperWidth?: number;' + return: + type: number + - name: printZoomRow + uid: word!Word.DocumentPrintOutOptions#printZoomRow:member + package: word! + fullName: printZoomRow + summary: >- + If provided, specifies the zoom row setting. The default value is `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printZoomRow?: number;' + return: + type: number + - name: range + uid: word!Word.DocumentPrintOutOptions#range:member + package: word! + fullName: range + summary: >- + If provided, specifies the range to print. The default value is + `allDocument`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + range?: Word.PrintOutRange | "AllDocument" | "Selection" | "CurrentPage" + | "FromTo" | "RangeOfPages"; + return: + type: >- + | "AllDocument" | + "Selection" | "CurrentPage" | "FromTo" | "RangeOfPages" + - name: to + uid: word!Word.DocumentPrintOutOptions#to:member + package: word! + fullName: to + summary: >- + If provided, specifies the ending page number. The default value is the + last page of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'to?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.documentprotectoptions.yml b/docs/docs-ref-autogen/word/word/word.documentprotectoptions.yml new file mode 100644 index 0000000000..ce1daac454 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentprotectoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Word.DocumentProtectOptions +uid: word!Word.DocumentProtectOptions:interface +package: word! +fullName: Word.DocumentProtectOptions +summary: >- + Provides configuration options for the + [Document.protect](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: enforceStyleLock + uid: word!Word.DocumentProtectOptions#enforceStyleLock:member + package: word! + fullName: enforceStyleLock + summary: >- + If provided, specifies whether to enforce style lock restrictions. The + default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'enforceStyleLock?: boolean;' + return: + type: boolean + - name: noReset + uid: word!Word.DocumentProtectOptions#noReset:member + package: word! + fullName: noReset + summary: >- + If provided, specifies whether to reset form fields when protecting the + document. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noReset?: boolean;' + return: + type: boolean + - name: password + uid: word!Word.DocumentProtectOptions#password:member + package: word! + fullName: password + summary: >- + If provided, specifies the password to apply for document protection. The + default value is an empty string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'password?: string;' + return: + type: string + - name: useInformationRightsManagement + uid: word!Word.DocumentProtectOptions#useInformationRightsManagement:member + package: word! + fullName: useInformationRightsManagement + summary: >- + If provided, specifies whether to use Information Rights Management (IRM). + The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useInformationRightsManagement?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.documentrangeoptions.yml b/docs/docs-ref-autogen/word/word/word.documentrangeoptions.yml new file mode 100644 index 0000000000..5f6f35a247 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentrangeoptions.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Word.DocumentRangeOptions +uid: word!Word.DocumentRangeOptions:interface +package: word! +fullName: Word.DocumentRangeOptions +summary: >- + Provides configuration options for the + [Document.range](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: end + uid: word!Word.DocumentRangeOptions#end:member + package: word! + fullName: end + summary: >- + If provided, specifies the ending character position. The default value is + the end of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end?: number;' + return: + type: number + - name: start + uid: word!Word.DocumentRangeOptions#start:member + package: word! + fullName: start + summary: >- + If provided, specifies the starting character position. The default value + is `0`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.documentreplywithchangesoptions.yml b/docs/docs-ref-autogen/word/word/word.documentreplywithchangesoptions.yml new file mode 100644 index 0000000000..a09b388cfe --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentreplywithchangesoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Word.DocumentReplyWithChangesOptions +uid: word!Word.DocumentReplyWithChangesOptions:interface +package: word! +fullName: Word.DocumentReplyWithChangesOptions +summary: >- + Provides configuration options for the + [Document.replyWithChanges](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: includeAttachment + uid: word!Word.DocumentReplyWithChangesOptions#includeAttachment:member + package: word! + fullName: includeAttachment + summary: >- + If provided, specifies whether to include the document as an attachment. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeAttachment?: boolean;' + return: + type: boolean + - name: recipients + uid: word!Word.DocumentReplyWithChangesOptions#recipients:member + package: word! + fullName: recipients + summary: >- + If provided, specifies the recipients of the reply. The default value is + "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'recipients?: string;' + return: + type: string + - name: showMessage + uid: word!Word.DocumentReplyWithChangesOptions#showMessage:member + package: word! + fullName: showMessage + summary: >- + If provided, specifies whether to show the message before sending. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'showMessage?: boolean;' + return: + type: boolean + - name: subject + uid: word!Word.DocumentReplyWithChangesOptions#subject:member + package: word! + fullName: subject + summary: >- + If provided, specifies the subject of the reply email. The default value + is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.documentsendfaxoverinternetoptions.yml b/docs/docs-ref-autogen/word/word/word.documentsendfaxoverinternetoptions.yml new file mode 100644 index 0000000000..f5d0593a16 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentsendfaxoverinternetoptions.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Word.DocumentSendFaxOverInternetOptions +uid: word!Word.DocumentSendFaxOverInternetOptions:interface +package: word! +fullName: Word.DocumentSendFaxOverInternetOptions +summary: >- + Provides configuration options for the + [Document.sendFaxOverInternet](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: recipients + uid: word!Word.DocumentSendFaxOverInternetOptions#recipients:member + package: word! + fullName: recipients + summary: >- + If provided, specifies the recipients of the fax. The default value is "" + (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'recipients?: string;' + return: + type: string + - name: showMessage + uid: word!Word.DocumentSendFaxOverInternetOptions#showMessage:member + package: word! + fullName: showMessage + summary: >- + If provided, specifies whether to show the message before sending. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'showMessage?: boolean;' + return: + type: boolean + - name: subject + uid: word!Word.DocumentSendFaxOverInternetOptions#subject:member + package: word! + fullName: subject + summary: >- + If provided, specifies the subject of the fax. The default value is "" + (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.documentsendforreviewoptions.yml b/docs/docs-ref-autogen/word/word/word.documentsendforreviewoptions.yml new file mode 100644 index 0000000000..352214693a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documentsendforreviewoptions.yml @@ -0,0 +1,84 @@ +### YamlMime:TSType +name: Word.DocumentSendForReviewOptions +uid: word!Word.DocumentSendForReviewOptions:interface +package: word! +fullName: Word.DocumentSendForReviewOptions +summary: >- + Provides configuration options for the + [Document.sendForReview](xref:word!Word.Document:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: includeAttachment + uid: word!Word.DocumentSendForReviewOptions#includeAttachment:member + package: word! + fullName: includeAttachment + summary: >- + If provided, specifies whether to include the document as an attachment. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeAttachment?: boolean;' + return: + type: boolean + - name: recipients + uid: word!Word.DocumentSendForReviewOptions#recipients:member + package: word! + fullName: recipients + summary: >- + If provided, specifies the recipients of the review request. The default + value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'recipients?: string;' + return: + type: string + - name: showMessage + uid: word!Word.DocumentSendForReviewOptions#showMessage:member + package: word! + fullName: showMessage + summary: >- + If provided, specifies whether to show the message before sending. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'showMessage?: boolean;' + return: + type: boolean + - name: subject + uid: word!Word.DocumentSendForReviewOptions#subject:member + package: word! + fullName: subject + summary: >- + If provided, specifies the subject of the review email. The default value + is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'subject?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.documenttype.yml b/docs/docs-ref-autogen/word/word/word.documenttype.yml new file mode 100644 index 0000000000..36e254e6fb --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.documenttype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.DocumentType +uid: word!Word.DocumentType:enum +package: word! +fullName: Word.DocumentType +summary: Specifies the type of document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: document + uid: word!Word.DocumentType.document:member + package: word! + summary: >- + Represents a standard document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Document"' + - name: frameset + uid: word!Word.DocumentType.frameset:member + package: word! + summary: >- + Represents a frameset document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Frameset"' + - name: template + uid: word!Word.DocumentType.template:member + package: word! + summary: >- + Represents a document template. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Template"' diff --git a/docs/docs-ref-autogen/word/word/word.exportcreatebookmarks.yml b/docs/docs-ref-autogen/word/word/word.exportcreatebookmarks.yml new file mode 100644 index 0000000000..c0bc67bff5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.exportcreatebookmarks.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.ExportCreateBookmarks +uid: word!Word.ExportCreateBookmarks:enum +package: word! +fullName: Word.ExportCreateBookmarks +summary: Specifies the type of bookmarks to create during export. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: headings + uid: word!Word.ExportCreateBookmarks.headings:member + package: word! + summary: >- + Creates bookmarks from headings. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Headings"' + - name: none + uid: word!Word.ExportCreateBookmarks.none:member + package: word! + summary: >- + Do not create bookmarks. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"None"' + - name: wordBookmarks + uid: word!Word.ExportCreateBookmarks.wordBookmarks:member + package: word! + summary: >- + Creates bookmarks from Word bookmarks. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"WordBookmarks"' diff --git a/docs/docs-ref-autogen/word/word/word.exportformat.yml b/docs/docs-ref-autogen/word/word/word.exportformat.yml new file mode 100644 index 0000000000..4a5f237b71 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.exportformat.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.ExportFormat +uid: word!Word.ExportFormat:enum +package: word! +fullName: Word.ExportFormat +summary: Specifies the export format for a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: pdf + uid: word!Word.ExportFormat.pdf:member + package: word! + summary: >- + PDF export format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Pdf"' + - name: xps + uid: word!Word.ExportFormat.xps:member + package: word! + summary: >- + XPS export format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Xps"' diff --git a/docs/docs-ref-autogen/word/word/word.exportitem.yml b/docs/docs-ref-autogen/word/word/word.exportitem.yml new file mode 100644 index 0000000000..155b7b12dc --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.exportitem.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.ExportItem +uid: word!Word.ExportItem:enum +package: word! +fullName: Word.ExportItem +summary: Specifies the export item type for a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: documentContent + uid: word!Word.ExportItem.documentContent:member + package: word! + summary: >- + Exports document content only. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentContent"' + - name: documentWithMarkup + uid: word!Word.ExportItem.documentWithMarkup:member + package: word! + summary: >- + Exports document with markup (annotations). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentWithMarkup"' diff --git a/docs/docs-ref-autogen/word/word/word.exportoptimizefor.yml b/docs/docs-ref-autogen/word/word/word.exportoptimizefor.yml new file mode 100644 index 0000000000..5551f5d053 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.exportoptimizefor.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.ExportOptimizeFor +uid: word!Word.ExportOptimizeFor:enum +package: word! +fullName: Word.ExportOptimizeFor +summary: Specifies the optimization target for document export. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: onScreen + uid: word!Word.ExportOptimizeFor.onScreen:member + package: word! + summary: >- + Optimizes for on-screen display. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OnScreen"' + - name: print + uid: word!Word.ExportOptimizeFor.print:member + package: word! + summary: >- + Optimizes for print. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Print"' diff --git a/docs/docs-ref-autogen/word/word/word.exportrange.yml b/docs/docs-ref-autogen/word/word/word.exportrange.yml new file mode 100644 index 0000000000..29366ec160 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.exportrange.yml @@ -0,0 +1,53 @@ +### YamlMime:TSEnum +name: Word.ExportRange +uid: word!Word.ExportRange:enum +package: word! +fullName: Word.ExportRange +summary: Specifies the range to export from a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: allDocument + uid: word!Word.ExportRange.allDocument:member + package: word! + summary: >- + Exports the entire document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AllDocument"' + - name: currentPage + uid: word!Word.ExportRange.currentPage:member + package: word! + summary: >- + Exports the current page. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CurrentPage"' + - name: fromTo + uid: word!Word.ExportRange.fromTo:member + package: word! + summary: >- + Exports a specific range of pages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FromTo"' + - name: selection + uid: word!Word.ExportRange.selection:member + package: word! + summary: >- + Exports the current selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Selection"' diff --git a/docs/docs-ref-autogen/word/word/word.filesaveformat.yml b/docs/docs-ref-autogen/word/word/word.filesaveformat.yml new file mode 100644 index 0000000000..46fa0b20f8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.filesaveformat.yml @@ -0,0 +1,266 @@ +### YamlMime:TSEnum +name: Word.FileSaveFormat +uid: word!Word.FileSaveFormat:enum +package: word! +fullName: Word.FileSaveFormat +summary: Represents the file format to use when saving a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: document + uid: word!Word.FileSaveFormat.document:member + package: word! + summary: >- + Represents Microsoft Office Word 97 - 2003 binary file format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Document"' + - name: documentDefault + uid: word!Word.FileSaveFormat.documentDefault:member + package: word! + summary: >- + Represents Word default document file format. For Word, this is the DOCX + format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentDefault"' + - name: dosText + uid: word!Word.FileSaveFormat.dosText:member + package: word! + summary: >- + Represents Microsoft DOS text format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DosText"' + - name: dosTextLineBreaks + uid: word!Word.FileSaveFormat.dosTextLineBreaks:member + package: word! + summary: >- + Represents Microsoft DOS text with line breaks preserved. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DosTextLineBreaks"' + - name: filteredHtml + uid: word!Word.FileSaveFormat.filteredHtml:member + package: word! + summary: >- + Represents filtered HTML format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FilteredHtml"' + - name: flatXml + uid: word!Word.FileSaveFormat.flatXml:member + package: word! + summary: >- + Represents Open XML file format saved as a single XML file. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FlatXml"' + - name: flatXmlMacroEnabled + uid: word!Word.FileSaveFormat.flatXmlMacroEnabled:member + package: word! + summary: >- + Represents Open XML file format with macros enabled saved as a single XML + file. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FlatXmlMacroEnabled"' + - name: flatXmlTemplate + uid: word!Word.FileSaveFormat.flatXmlTemplate:member + package: word! + summary: >- + Represents Open XML template format saved as a single XML file. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FlatXmlTemplate"' + - name: flatXmlTemplateMacroEnabled + uid: word!Word.FileSaveFormat.flatXmlTemplateMacroEnabled:member + package: word! + summary: >- + Represents Open XML template format with macros enabled saved as a single + XML file. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FlatXmlTemplateMacroEnabled"' + - name: html + uid: word!Word.FileSaveFormat.html:member + package: word! + summary: >- + Represents standard HTML format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Html"' + - name: openDocumentText + uid: word!Word.FileSaveFormat.openDocumentText:member + package: word! + summary: >- + Represents OpenDocument Text format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OpenDocumentText"' + - name: pdf + uid: word!Word.FileSaveFormat.pdf:member + package: word! + summary: >- + Represents PDF format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Pdf"' + - name: rtf + uid: word!Word.FileSaveFormat.rtf:member + package: word! + summary: >- + Represents Rich Text Format (RTF). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Rtf"' + - name: strictOpenXmlDocument + uid: word!Word.FileSaveFormat.strictOpenXmlDocument:member + package: word! + summary: >- + Represents Strict Open XML document format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"StrictOpenXmlDocument"' + - name: template + uid: word!Word.FileSaveFormat.template:member + package: word! + summary: >- + Represents Word template format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Template"' + - name: text + uid: word!Word.FileSaveFormat.text:member + package: word! + summary: >- + Represents Microsoft Windows text format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Text"' + - name: textLineBreaks + uid: word!Word.FileSaveFormat.textLineBreaks:member + package: word! + summary: >- + Represents Windows text format with line breaks preserved. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TextLineBreaks"' + - name: unicodeText + uid: word!Word.FileSaveFormat.unicodeText:member + package: word! + summary: >- + Represents Unicode text format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UnicodeText"' + - name: webArchive + uid: word!Word.FileSaveFormat.webArchive:member + package: word! + summary: >- + Represents Web archive format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"WebArchive"' + - name: xml + uid: word!Word.FileSaveFormat.xml:member + package: word! + summary: >- + Represents Extensible Markup Language (XML) format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Xml"' + - name: xmlDocument + uid: word!Word.FileSaveFormat.xmlDocument:member + package: word! + summary: >- + Represents XML document format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"XmlDocument"' + - name: xmlDocumentMacroEnabled + uid: word!Word.FileSaveFormat.xmlDocumentMacroEnabled:member + package: word! + summary: >- + Represents XML document format with macros enabled. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"XmlDocumentMacroEnabled"' + - name: xmlTemplate + uid: word!Word.FileSaveFormat.xmlTemplate:member + package: word! + summary: >- + Represents XML template format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"XmlTemplate"' + - name: xmlTemplateMacroEnabled + uid: word!Word.FileSaveFormat.xmlTemplateMacroEnabled:member + package: word! + summary: >- + Represents XML template format with macros enabled. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"XmlTemplateMacroEnabled"' + - name: xps + uid: word!Word.FileSaveFormat.xps:member + package: word! + summary: >- + Represents XPS format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Xps"' diff --git a/docs/docs-ref-autogen/word/word/word.gotooptions.yml b/docs/docs-ref-autogen/word/word/word.gotooptions.yml new file mode 100644 index 0000000000..db774266d4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.gotooptions.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Word.GoToOptions +uid: word!Word.GoToOptions:interface +package: word! +fullName: Word.GoToOptions +summary: >- + Represents the options for the + [Selection.goTo](xref:word!Word.Selection:class) and + [Document.goTo](xref:word!Word.Document:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.GoToOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of the item in the document. Only + positive values are valid. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: direction + uid: word!Word.GoToOptions#direction:member + package: word! + fullName: direction + summary: >- + If provided, specifies the direction the range or selection is moved to. + The default value is `next`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous";' + return: + type: >- + | "First" | "Last" | + "Next" | "Previous" + - name: item + uid: word!Word.GoToOptions#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the kind of item the range or selection is moved + to. The default value is `page`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | + "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | + "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError"; + return: + type: >- + | "Bookmark" | "Comment" | + "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | + "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | + "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError" + - name: name + uid: word!Word.GoToOptions#name:member + package: word! + fullName: name + summary: >- + If provided, specifies the name if the `item` property is set to + [Word.GoToItem](xref:word!Word.GoToItem:enum) type `bookmark`, + `comment`, `field`, or `object`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.htmldivision.yml b/docs/docs-ref-autogen/word/word/word.htmldivision.yml new file mode 100644 index 0000000000..52e5728a10 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.htmldivision.yml @@ -0,0 +1,312 @@ +### YamlMime:TSType +name: Word.HtmlDivision +uid: word!Word.HtmlDivision:class +package: word! +fullName: Word.HtmlDivision +summary: '' +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.HtmlDivision#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: htmlDivisions + uid: word!Word.HtmlDivision#htmlDivisions:member + package: word! + fullName: htmlDivisions + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly htmlDivisions: Word.HtmlDivisionCollection;' + return: + type: + - name: leftIndent + uid: word!Word.HtmlDivision#leftIndent:member + package: word! + fullName: leftIndent + summary: Specifies the left indent value (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent: number;' + return: + type: number + - name: range + uid: word!Word.HtmlDivision#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of a document that's + contained in this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: rightIndent + uid: word!Word.HtmlDivision#rightIndent:member + package: word! + fullName: rightIndent + summary: Specifies the right indent (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightIndent: number;' + return: + type: number + - name: spaceAfter + uid: word!Word.HtmlDivision#spaceAfter:member + package: word! + fullName: spaceAfter + summary: Specifies the amount of spacing (in points) after this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceAfter: number;' + return: + type: number + - name: spaceBefore + uid: word!Word.HtmlDivision#spaceBefore:member + package: word! + fullName: spaceBefore + summary: Specifies the spacing (in points) before this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceBefore: number;' + return: + type: number +methods: + - name: delete() + uid: word!Word.HtmlDivision#delete:member(1) + package: word! + fullName: delete() + summary: Deletes this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: htmlDivisionParent(levelsUp) + uid: word!Word.HtmlDivision#htmlDivisionParent:member(1) + package: word! + fullName: htmlDivisionParent(levelsUp) + summary: >- + Returns an `HtmlDivision` object that represents a parent division of the + current HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;' + parameters: + - id: levelsUp + description: >- + Optional. The number of levels to go up to retrieve the parent + division. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.HtmlDivision#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.HtmlDivisionLoadOptions): + Word.HtmlDivision; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.HtmlDivision#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.HtmlDivision;' + 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.HtmlDivision#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.HtmlDivision; + 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: toJSON() + uid: word!Word.HtmlDivision#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.HtmlDivision` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.HtmlDivisionData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.HtmlDivisionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.HtmlDivision#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.HtmlDivision;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.HtmlDivision#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.HtmlDivision;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.htmldivisioncollection.yml b/docs/docs-ref-autogen/word/word/word.htmldivisioncollection.yml new file mode 100644 index 0000000000..6c305b186d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.htmldivisioncollection.yml @@ -0,0 +1,170 @@ +### YamlMime:TSType +name: Word.HtmlDivisionCollection +uid: word!Word.HtmlDivisionCollection:class +package: word! +fullName: Word.HtmlDivisionCollection +summary: >- + Represents a collection of + [Word.HtmlDivision](xref:word!Word.HtmlDivision:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.HtmlDivisionCollection#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.HtmlDivisionCollection#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.HtmlDivision[];' + return: + type: [] +methods: + - name: getItemAt(index) + uid: word!Word.HtmlDivisionCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: >- + Returns an `HtmlDivision` object from the collection based on the + specified index. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Word.HtmlDivision;' + parameters: + - id: index + description: The index of the `HtmlDivision` to retrieve. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.HtmlDivisionCollection#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.HtmlDivisionCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.HtmlDivisionCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.HtmlDivisionCollection#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.HtmlDivisionCollection;' + 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.HtmlDivisionCollection#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.HtmlDivisionCollection; + 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.HtmlDivisionCollection#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.HtmlDivisionCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.HtmlDivisionCollectionData`) 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.HtmlDivisionCollectionData;' + return: + type: >- + + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml index 1ac4773961..3e7e93fcdf 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml @@ -57,8 +57,8 @@ properties: fullName: name summary: >- For EACH ITEM in the collection: Gets the name of the error in the - `CustomXmlValidationError` object.If no errors exist, the property returns - `Nothing` + `CustomXmlValidationError` object. If no errors exist, the property + returns `Nothing` remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -76,7 +76,7 @@ properties: fullName: node summary: >- For EACH ITEM in the collection: Gets the node associated with this - `CustomXmlValidationError` object, if any exist.If no nodes exist, the + `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. remarks: >- \[ [API set: WordApi BETA (PREVIEW diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml index da867ea94c..09070960db 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml @@ -34,7 +34,7 @@ properties: package: word! fullName: name summary: >- - Gets the name of the error in the `CustomXmlValidationError` object.If no + Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` remarks: >- \[ [API set: WordApi BETA (PREVIEW @@ -52,7 +52,7 @@ properties: fullName: node summary: >- Gets the node associated with this `CustomXmlValidationError` object, if - any exist.If no nodes exist, the property returns `Nothing`. + any exist. If no nodes exist, the property returns `Nothing`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml index 9a3880917d..1c75b21d81 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml @@ -53,7 +53,7 @@ properties: package: word! fullName: name summary: >- - Gets the name of the error in the `CustomXmlValidationError` object.If no + Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` remarks: >- \[ [API set: WordApi BETA (PREVIEW @@ -71,7 +71,7 @@ properties: fullName: node summary: >- Gets the node associated with this `CustomXmlValidationError` object, if - any exist.If no nodes exist, the property returns `Nothing`. + any exist. If no nodes exist, the property returns `Nothing`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorupdatedata.yml index 7990994e59..b3b5d8c847 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorupdatedata.yml @@ -18,7 +18,7 @@ properties: fullName: node summary: >- Gets the node associated with this `CustomXmlValidationError` object, if - any exist.If no nodes exist, the property returns `Nothing`. + any exist. If no nodes exist, the property returns `Nothing`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml index 43a84aa70d..1c30cbe3f5 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml @@ -12,6 +12,36 @@ isPreview: false isDeprecated: false type: interface properties: + - name: activeTheme + uid: word!Word.Interfaces.DocumentData#activeTheme:member + package: word! + fullName: activeTheme + summary: Gets the name of the active theme and formatting options. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activeTheme?: string;' + return: + type: string + - name: activeThemeDisplayName + uid: word!Word.Interfaces.DocumentData#activeThemeDisplayName:member + package: word! + fullName: activeThemeDisplayName + summary: Gets the display name of the active theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activeThemeDisplayName?: string;' + return: + type: string - name: activeWindow uid: word!Word.Interfaces.DocumentData#activeWindow:member package: word! @@ -27,6 +57,126 @@ properties: content: 'activeWindow?: Word.Interfaces.WindowData;' return: type: + - name: areFilePropertiesPasswordEncrypted + uid: >- + word!Word.Interfaces.DocumentData#areFilePropertiesPasswordEncrypted:member + package: word! + fullName: areFilePropertiesPasswordEncrypted + summary: >- + Gets whether Word encrypts file properties for password-protected + documents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFilePropertiesPasswordEncrypted?: boolean;' + return: + type: boolean + - name: areGrammaticalErrorsShown + uid: word!Word.Interfaces.DocumentData#areGrammaticalErrorsShown:member + package: word! + fullName: areGrammaticalErrorsShown + summary: >- + Specifies whether grammatical errors are marked by a wavy green line in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areGrammaticalErrorsShown?: boolean;' + return: + type: boolean + - name: areMathDefaultsUsed + uid: word!Word.Interfaces.DocumentData#areMathDefaultsUsed:member + package: word! + fullName: areMathDefaultsUsed + summary: >- + Specifies whether to use the default math settings when creating new + equations. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areMathDefaultsUsed?: boolean;' + return: + type: boolean + - name: areNewerFeaturesDisabled + uid: word!Word.Interfaces.DocumentData#areNewerFeaturesDisabled:member + package: word! + fullName: areNewerFeaturesDisabled + summary: >- + Specifies whether to disable features introduced after a specified + version. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areNewerFeaturesDisabled?: boolean;' + return: + type: boolean + - name: areSpellingErrorsShown + uid: word!Word.Interfaces.DocumentData#areSpellingErrorsShown:member + package: word! + fullName: areSpellingErrorsShown + summary: >- + Specifies whether Microsoft Word underlines spelling errors in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areSpellingErrorsShown?: boolean;' + return: + type: boolean + - name: areStylesUpdatedOnOpen + uid: word!Word.Interfaces.DocumentData#areStylesUpdatedOnOpen:member + package: word! + fullName: areStylesUpdatedOnOpen + summary: >- + Specifies whether the styles in this document are updated to match the + styles in the attached template each time the document is opened. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areStylesUpdatedOnOpen?: boolean;' + return: + type: boolean + - name: areTrueTypeFontsEmbedded + uid: word!Word.Interfaces.DocumentData#areTrueTypeFontsEmbedded:member + package: word! + fullName: areTrueTypeFontsEmbedded + summary: >- + Specifies whether Microsoft Word embeds TrueType fonts in the document + when it's saved. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areTrueTypeFontsEmbedded?: boolean;' + return: + type: boolean - name: autoHyphenation uid: word!Word.Interfaces.DocumentData#autoHyphenation:member package: word! @@ -125,6 +275,40 @@ properties: content: 'coauthoring?: Word.Interfaces.CoauthoringData;' return: type: + - name: codeName + uid: word!Word.Interfaces.DocumentData#codeName:member + package: word! + fullName: codeName + summary: Gets the code name for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'codeName?: string;' + return: + type: string + - name: compatibilityMode + uid: word!Word.Interfaces.DocumentData#compatibilityMode:member + package: word! + fullName: compatibilityMode + summary: Gets the compatibility mode that Word uses when opening the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | + "Word2010" | "Word2013" | "Current"; + return: + type: >- + | "Word2003" | + "Word2007" | "Word2010" | "Word2013" | "Current" - name: consecutiveHyphensLimit uid: word!Word.Interfaces.DocumentData#consecutiveHyphensLimit:member package: word! @@ -160,6 +344,21 @@ properties: content: 'contentControls?: Word.Interfaces.ContentControlData[];' return: type: [] + - name: currentRsid + uid: word!Word.Interfaces.DocumentData#currentRsid:member + package: word! + fullName: currentRsid + summary: Gets a random number that Word assigns to changes in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'currentRsid?: number;' + return: + type: number - name: customXmlParts uid: word!Word.Interfaces.DocumentData#customXmlParts:member package: word! @@ -175,6 +374,38 @@ properties: content: 'customXmlParts?: Word.Interfaces.CustomXmlPartData[];' return: type: [] + - name: defaultTabStop + uid: word!Word.Interfaces.DocumentData#defaultTabStop:member + package: word! + fullName: defaultTabStop + summary: >- + Specifies the interval (in points) between the default tab stops in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'defaultTabStop?: number;' + return: + type: number + - name: defaultTargetFrame + uid: word!Word.Interfaces.DocumentData#defaultTargetFrame:member + package: word! + fullName: defaultTargetFrame + summary: Specifies the browser frame for displaying a webpage via hyperlink. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'defaultTargetFrame?: string;' + return: + type: string - name: documentLibraryVersions uid: word!Word.Interfaces.DocumentData#documentLibraryVersions:member package: word! @@ -195,13 +426,11 @@ properties: type: >- [] - - name: frames - uid: word!Word.Interfaces.DocumentData#frames:member + - name: doNotEmbedSystemFonts + uid: word!Word.Interfaces.DocumentData#doNotEmbedSystemFonts:member package: word! - fullName: frames - summary: >- - Returns a `FrameCollection` object that represents all the frames in the - document. + fullName: doNotEmbedSystemFonts + summary: Specifies whether Word should not embed common system fonts. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -209,16 +438,16 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'frames?: Word.Interfaces.FrameData[];' + content: 'doNotEmbedSystemFonts?: boolean;' return: - type: [] - - name: hyperlinks - uid: word!Word.Interfaces.DocumentData#hyperlinks:member + type: boolean + - name: encryptionProvider + uid: word!Word.Interfaces.DocumentData#encryptionProvider:member package: word! - fullName: hyperlinks + fullName: encryptionProvider summary: >- - Returns a `HyperlinkCollection` object that represents all the hyperlinks - in the document. + Specifies the name of the algorithm encryption provider that Microsoft + Word uses when encrypting documents. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -226,14 +455,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'hyperlinks?: Word.Interfaces.HyperlinkData[];' + content: 'encryptionProvider?: string;' return: - type: [] - - name: hyphenateCaps - uid: word!Word.Interfaces.DocumentData#hyphenateCaps:member + type: string + - name: farEastLineBreakLanguage + uid: word!Word.Interfaces.DocumentData#farEastLineBreakLanguage:member package: word! - fullName: hyphenateCaps - summary: Specifies whether words in all capital letters can be hyphenated. + fullName: farEastLineBreakLanguage + summary: Specifies the East Asian language used for line breaking. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -241,16 +470,18 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'hyphenateCaps?: boolean;' + content: >- + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; return: - type: boolean - - name: languageDetected - uid: word!Word.Interfaces.DocumentData#languageDetected:member + type: >- + | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese" + - name: farEastLineBreakLevel + uid: word!Word.Interfaces.DocumentData#farEastLineBreakLevel:member package: word! - fullName: languageDetected - summary: >- - Specifies whether Microsoft Word has detected the language of the document - text. + fullName: farEastLineBreakLevel + summary: Specifies the line break control level. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -258,16 +489,20 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'languageDetected?: boolean;' + content: >- + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" + | "Custom"; return: - type: boolean - - name: listTemplates - uid: word!Word.Interfaces.DocumentData#listTemplates:member + type: >- + | "Normal" | + "Strict" | "Custom" + - name: formattingIsNextLevelShown + uid: word!Word.Interfaces.DocumentData#formattingIsNextLevelShown:member package: word! - fullName: listTemplates + fullName: formattingIsNextLevelShown summary: >- - Returns a `ListTemplateCollection` object that represents all the list - templates in the document. + Specifies whether Word shows the next heading level when the previous is + used. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -275,14 +510,14 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'listTemplates?: Word.Interfaces.ListTemplateData[];' + content: 'formattingIsNextLevelShown?: boolean;' return: - type: [] - - name: pageSetup - uid: word!Word.Interfaces.DocumentData#pageSetup:member + type: boolean + - name: formattingIsUserStyleNameShown + uid: word!Word.Interfaces.DocumentData#formattingIsUserStyleNameShown:member package: word! - fullName: pageSetup - summary: Returns a `PageSetup` object that's associated with the document. + fullName: formattingIsUserStyleNameShown + summary: Specifies whether to show user-defined styles. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -290,63 +525,67 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'pageSetup?: Word.Interfaces.PageSetupData;' + content: 'formattingIsUserStyleNameShown?: boolean;' return: - type: - - name: properties - uid: word!Word.Interfaces.DocumentData#properties:member + type: boolean + - name: frames + uid: word!Word.Interfaces.DocumentData#frames:member package: word! - fullName: properties - summary: Gets the properties of the document. + fullName: frames + summary: >- + Returns a `FrameCollection` object that represents all the frames in the + document. remarks: >- - \[ [API set: WordApi - 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'properties?: Word.Interfaces.DocumentPropertiesData;' + content: 'frames?: Word.Interfaces.FrameData[];' return: - type: - - name: saved - uid: word!Word.Interfaces.DocumentData#saved:member + type: [] + - name: fullName + uid: word!Word.Interfaces.DocumentData#fullName:member package: word! - fullName: saved - summary: >- - 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. + fullName: fullName + summary: Gets the name of a document, including the path. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'saved?: boolean;' + content: 'fullName?: string;' return: - type: boolean - - name: sections - uid: word!Word.Interfaces.DocumentData#sections:member + type: string + - name: gridDistanceHorizontal + uid: word!Word.Interfaces.DocumentData#gridDistanceHorizontal:member package: word! - fullName: sections - summary: Gets the collection of section objects in the document. + fullName: gridDistanceHorizontal + summary: >- + Specifies the horizontal space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'sections?: Word.Interfaces.SectionData[];' + content: 'gridDistanceHorizontal?: number;' return: - type: [] - - name: selection - uid: word!Word.Interfaces.DocumentData#selection:member + type: number + - name: gridDistanceVertical + uid: word!Word.Interfaces.DocumentData#gridDistanceVertical:member package: word! - fullName: selection + fullName: gridDistanceVertical summary: >- - Returns a `Selection` object that represents the current selection in the - document. + Specifies the vertical space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -354,14 +593,1236 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'selection?: Word.Interfaces.SelectionData;' + content: 'gridDistanceVertical?: number;' return: - type: - - name: settings - uid: word!Word.Interfaces.DocumentData#settings:member + type: number + - name: gridIsOriginFromMargin + uid: word!Word.Interfaces.DocumentData#gridIsOriginFromMargin:member package: word! - fullName: settings - summary: Gets the add-in's settings in the document. + fullName: gridIsOriginFromMargin + summary: >- + Specifies whether the character grid starts from the upper-left corner of + the page. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridIsOriginFromMargin?: boolean;' + return: + type: boolean + - name: gridOriginHorizontal + uid: word!Word.Interfaces.DocumentData#gridOriginHorizontal:member + package: word! + fullName: gridOriginHorizontal + summary: Specifies the horizontal origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginHorizontal?: number;' + return: + type: number + - name: gridOriginVertical + uid: word!Word.Interfaces.DocumentData#gridOriginVertical:member + package: word! + fullName: gridOriginVertical + summary: Specifies the vertical origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginVertical?: number;' + return: + type: number + - name: gridSpaceBetweenHorizontalLines + uid: word!Word.Interfaces.DocumentData#gridSpaceBetweenHorizontalLines:member + package: word! + fullName: gridSpaceBetweenHorizontalLines + summary: >- + Specifies the interval for horizontal character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenHorizontalLines?: number;' + return: + type: number + - name: gridSpaceBetweenVerticalLines + uid: word!Word.Interfaces.DocumentData#gridSpaceBetweenVerticalLines:member + package: word! + fullName: gridSpaceBetweenVerticalLines + summary: >- + Specifies the interval for vertical character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenVerticalLines?: number;' + return: + type: number + - name: hasPassword + uid: word!Word.Interfaces.DocumentData#hasPassword:member + package: word! + fullName: hasPassword + summary: Gets whether a password is required to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasPassword?: boolean;' + return: + type: boolean + - name: hasVbProject + uid: word!Word.Interfaces.DocumentData#hasVbProject:member + package: word! + fullName: hasVbProject + summary: >- + Gets whether the document has an attached Microsoft Visual Basic for + Applications project. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasVbProject?: boolean;' + return: + type: boolean + - name: hyperlinks + uid: word!Word.Interfaces.DocumentData#hyperlinks:member + package: word! + fullName: hyperlinks + summary: >- + Returns a `HyperlinkCollection` object that represents all the hyperlinks + in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyperlinks?: Word.Interfaces.HyperlinkData[];' + return: + type: [] + - name: hyphenateCaps + uid: word!Word.Interfaces.DocumentData#hyphenateCaps:member + package: word! + fullName: hyphenateCaps + summary: Specifies whether words in all capital letters can be hyphenated. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenateCaps?: boolean;' + return: + type: boolean + - name: hyphenationZone + uid: word!Word.Interfaces.DocumentData#hyphenationZone:member + package: word! + fullName: hyphenationZone + summary: Specifies the width of the hyphenation zone, in points. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenationZone?: number;' + return: + type: number + - name: isAutoFormatOverrideOn + uid: word!Word.Interfaces.DocumentData#isAutoFormatOverrideOn:member + package: word! + fullName: isAutoFormatOverrideOn + summary: >- + Specifies whether automatic formatting options override formatting + restrictions. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isAutoFormatOverrideOn?: boolean;' + return: + type: boolean + - name: isChartDataPointTracked + uid: word!Word.Interfaces.DocumentData#isChartDataPointTracked:member + package: word! + fullName: isChartDataPointTracked + summary: >- + Specifies whether charts in the active document use cell-reference + data-point tracking. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isChartDataPointTracked?: boolean;' + return: + type: boolean + - name: isCompatible + uid: word!Word.Interfaces.DocumentData#isCompatible:member + package: word! + fullName: isCompatible + summary: >- + Specifies whether the compatibility option specified by the `type` + property is enabled. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCompatible?: boolean;' + return: + type: boolean + - name: isFinal + uid: word!Word.Interfaces.DocumentData#isFinal:member + package: word! + fullName: isFinal + summary: Specifies whether the document is final. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFinal?: boolean;' + return: + type: boolean + - name: isFontsSubsetSaved + uid: word!Word.Interfaces.DocumentData#isFontsSubsetSaved:member + package: word! + fullName: isFontsSubsetSaved + summary: >- + Specifies whether Microsoft Word saves a subset of the embedded TrueType + fonts with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFontsSubsetSaved?: boolean;' + return: + type: boolean + - name: isFormsDataPrinted + uid: word!Word.Interfaces.DocumentData#isFormsDataPrinted:member + package: word! + fullName: isFormsDataPrinted + summary: >- + Specifies whether Microsoft Word prints onto a preprinted form only the + data entered in the corresponding online form. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataPrinted?: boolean;' + return: + type: boolean + - name: isFormsDataSaved + uid: word!Word.Interfaces.DocumentData#isFormsDataSaved:member + package: word! + fullName: isFormsDataSaved + summary: >- + Specifies whether Microsoft Word saves the data entered in a form as a + tab-delimited record for use in a database. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataSaved?: boolean;' + return: + type: boolean + - name: isGrammarChecked + uid: word!Word.Interfaces.DocumentData#isGrammarChecked:member + package: word! + fullName: isGrammarChecked + summary: Specifies whether a grammar check has been run on the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isGrammarChecked?: boolean;' + return: + type: boolean + - name: isInAutoSave + uid: word!Word.Interfaces.DocumentData#isInAutoSave:member + package: word! + fullName: isInAutoSave + summary: >- + Gets whether the most recent firing of the + `Application.DocumentBeforeSave` event was the result of an automatic save + by the document or a manual save by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInAutoSave?: boolean;' + return: + type: boolean + - name: isInFormsDesign + uid: word!Word.Interfaces.DocumentData#isInFormsDesign:member + package: word! + fullName: isInFormsDesign + summary: Gets whether the document is in form design mode. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInFormsDesign?: boolean;' + return: + type: boolean + - name: isKerningByAlgorithm + uid: word!Word.Interfaces.DocumentData#isKerningByAlgorithm:member + package: word! + fullName: isKerningByAlgorithm + summary: >- + Specifies whether Word kerns half-width Latin characters and punctuation + marks. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isKerningByAlgorithm?: boolean;' + return: + type: boolean + - name: isLinguisticDataEmbedded + uid: word!Word.Interfaces.DocumentData#isLinguisticDataEmbedded:member + package: word! + fullName: isLinguisticDataEmbedded + summary: Specifies whether to embed speech and handwriting data. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLinguisticDataEmbedded?: boolean;' + return: + type: boolean + - name: isMasterDocument + uid: word!Word.Interfaces.DocumentData#isMasterDocument:member + package: word! + fullName: isMasterDocument + summary: Gets whether this document is a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isMasterDocument?: boolean;' + return: + type: boolean + - name: isOptimizedForWord97 + uid: word!Word.Interfaces.DocumentData#isOptimizedForWord97:member + package: word! + fullName: isOptimizedForWord97 + summary: Specifies whether Word optimizes the document for Word 97. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isOptimizedForWord97?: boolean;' + return: + type: boolean + - name: isPostScriptPrintedOverText + uid: word!Word.Interfaces.DocumentData#isPostScriptPrintedOverText:member + package: word! + fullName: isPostScriptPrintedOverText + summary: >- + Specifies whether [PRINT + field](https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f) + instructions (such as PostScript commands) in the document are to be + printed on top of text and graphics when a PostScript printer is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPostScriptPrintedOverText?: boolean;' + return: + type: boolean + - name: isQuickStyleSetLocked + uid: word!Word.Interfaces.DocumentData#isQuickStyleSetLocked:member + package: word! + fullName: isQuickStyleSetLocked + summary: Specifies whether users can change the Quick Style set. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isQuickStyleSetLocked?: boolean;' + return: + type: boolean + - name: isReadOnly + uid: word!Word.Interfaces.DocumentData#isReadOnly:member + package: word! + fullName: isReadOnly + summary: >- + Gets whether changes to the document cannot be saved to the original + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnly?: boolean;' + return: + type: boolean + - name: isReadOnlyRecommended + uid: word!Word.Interfaces.DocumentData#isReadOnlyRecommended:member + package: word! + fullName: isReadOnlyRecommended + summary: >- + Specifies whether Microsoft Word displays a message box whenever a user + opens the document, suggesting that it be opened as read-only. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnlyRecommended?: boolean;' + return: + type: boolean + - name: isSnappedToGrid + uid: word!Word.Interfaces.DocumentData#isSnappedToGrid:member + package: word! + fullName: isSnappedToGrid + summary: >- + Specifies whether AutoShapes or East Asian characters are automatically + aligned with an invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToGrid?: boolean;' + return: + type: boolean + - name: isSnappedToShapes + uid: word!Word.Interfaces.DocumentData#isSnappedToShapes:member + package: word! + fullName: isSnappedToShapes + summary: >- + Specifies whether AutoShapes or East Asian characters align with invisible + gridlines through other shapes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToShapes?: boolean;' + return: + type: boolean + - name: isSpellingChecked + uid: word!Word.Interfaces.DocumentData#isSpellingChecked:member + package: word! + fullName: isSpellingChecked + summary: Specifies whether spelling has been checked throughout the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSpellingChecked?: boolean;' + return: + type: boolean + - name: isStyleEnforced + uid: word!Word.Interfaces.DocumentData#isStyleEnforced:member + package: word! + fullName: isStyleEnforced + summary: >- + Specifies whether formatting restrictions are enforced in a protected + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStyleEnforced?: boolean;' + return: + type: boolean + - name: isSubdocument + uid: word!Word.Interfaces.DocumentData#isSubdocument:member + package: word! + fullName: isSubdocument + summary: Gets whether this document is a subdocument of a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSubdocument?: boolean;' + return: + type: boolean + - name: isThemeLocked + uid: word!Word.Interfaces.DocumentData#isThemeLocked:member + package: word! + fullName: isThemeLocked + summary: Specifies whether users can change the document theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isThemeLocked?: boolean;' + return: + type: boolean + - name: isUserControl + uid: word!Word.Interfaces.DocumentData#isUserControl:member + package: word! + fullName: isUserControl + summary: Specifies whether the document was created or opened by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isUserControl?: boolean;' + return: + type: boolean + - name: isVbaSigned + uid: word!Word.Interfaces.DocumentData#isVbaSigned:member + package: word! + fullName: isVbaSigned + summary: Gets whether the VBA project is digitally signed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isVbaSigned?: boolean;' + return: + type: boolean + - name: isWriteReserved + uid: word!Word.Interfaces.DocumentData#isWriteReserved:member + package: word! + fullName: isWriteReserved + summary: Gets whether the document is protected with a write password. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isWriteReserved?: boolean;' + return: + type: boolean + - name: justificationMode + uid: word!Word.Interfaces.DocumentData#justificationMode:member + package: word! + fullName: justificationMode + summary: Specifies the character spacing adjustment. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | + "CompressKana"; + return: + type: >- + | "Expand" | + "Compress" | "CompressKana" + - name: kind + uid: word!Word.Interfaces.DocumentData#kind:member + package: word! + fullName: kind + summary: >- + Specifies the format type that Microsoft Word uses when automatically + formatting the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";' + return: + type: >- + | "NotSpecified" | "Letter" + | "Email" + - name: languageDetected + uid: word!Word.Interfaces.DocumentData#languageDetected:member + package: word! + fullName: languageDetected + summary: >- + Specifies whether Microsoft Word has detected the language of the document + text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: listTemplates + uid: word!Word.Interfaces.DocumentData#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'listTemplates?: Word.Interfaces.ListTemplateData[];' + return: + type: [] + - name: noLineBreakAfter + uid: word!Word.Interfaces.DocumentData#noLineBreakAfter:member + package: word! + fullName: noLineBreakAfter + summary: Specifies the kinsoku characters after which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakAfter?: string;' + return: + type: string + - name: noLineBreakBefore + uid: word!Word.Interfaces.DocumentData#noLineBreakBefore:member + package: word! + fullName: noLineBreakBefore + summary: Specifies the kinsoku characters before which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakBefore?: string;' + return: + type: string + - name: openEncoding + uid: word!Word.Interfaces.DocumentData#openEncoding:member + package: word! + fullName: openEncoding + summary: Gets the encoding used to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: originalDocumentTitle + uid: word!Word.Interfaces.DocumentData#originalDocumentTitle:member + package: word! + fullName: originalDocumentTitle + summary: Gets the title of the original document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'originalDocumentTitle?: string;' + return: + type: string + - name: pageSetup + uid: word!Word.Interfaces.DocumentData#pageSetup:member + package: word! + fullName: pageSetup + summary: Returns a `PageSetup` object that's associated with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageSetup?: Word.Interfaces.PageSetupData;' + return: + type: + - name: password + uid: word!Word.Interfaces.DocumentData#password:member + package: word! + fullName: password + summary: Sets a password that must be supplied to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'password?: string;' + return: + type: string + - name: passwordEncryptionAlgorithm + uid: word!Word.Interfaces.DocumentData#passwordEncryptionAlgorithm:member + package: word! + fullName: passwordEncryptionAlgorithm + summary: Gets the algorithm used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionAlgorithm?: string;' + return: + type: string + - name: passwordEncryptionKeyLength + uid: word!Word.Interfaces.DocumentData#passwordEncryptionKeyLength:member + package: word! + fullName: passwordEncryptionKeyLength + summary: Gets the key length used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionKeyLength?: number;' + return: + type: number + - name: passwordEncryptionProvider + uid: word!Word.Interfaces.DocumentData#passwordEncryptionProvider:member + package: word! + fullName: passwordEncryptionProvider + summary: Gets the name of the password encryption provider. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionProvider?: string;' + return: + type: string + - name: path + uid: word!Word.Interfaces.DocumentData#path:member + package: word! + fullName: path + summary: >- + Gets the disk or the web path to the document (excludes the document + name). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'path?: string;' + return: + type: string + - name: printRevisions + uid: word!Word.Interfaces.DocumentData#printRevisions:member + package: word! + fullName: printRevisions + summary: Specifies whether revision marks are printed with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printRevisions?: boolean;' + return: + type: boolean + - name: properties + uid: word!Word.Interfaces.DocumentData#properties:member + package: word! + fullName: properties + summary: Gets the properties of the document. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Word.Interfaces.DocumentPropertiesData;' + return: + type: + - name: protectionType + uid: word!Word.Interfaces.DocumentData#protectionType:member + package: word! + fullName: protectionType + summary: Gets the protection type for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + protectionType?: Word.ProtectionType | "NoProtection" | + "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | + "AllowOnlyReading"; + return: + type: >- + | "NoProtection" | + "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | + "AllowOnlyReading" + - name: readingLayoutSizeX + uid: word!Word.Interfaces.DocumentData#readingLayoutSizeX:member + package: word! + fullName: readingLayoutSizeX + summary: Specifies the width of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeX?: number;' + return: + type: number + - name: readingLayoutSizeY + uid: word!Word.Interfaces.DocumentData#readingLayoutSizeY:member + package: word! + fullName: readingLayoutSizeY + summary: Specifies the height of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeY?: number;' + return: + type: number + - name: readingModeIsLayoutFrozen + uid: word!Word.Interfaces.DocumentData#readingModeIsLayoutFrozen:member + package: word! + fullName: readingModeIsLayoutFrozen + summary: >- + Specifies whether pages in reading layout view are frozen for handwritten + markup. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingModeIsLayoutFrozen?: boolean;' + return: + type: boolean + - name: removePersonalInformationOnSave + uid: word!Word.Interfaces.DocumentData#removePersonalInformationOnSave:member + package: word! + fullName: removePersonalInformationOnSave + summary: Specifies whether Word removes user information upon saving. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removePersonalInformationOnSave?: boolean;' + return: + type: boolean + - name: revisedDocumentTitle + uid: word!Word.Interfaces.DocumentData#revisedDocumentTitle:member + package: word! + fullName: revisedDocumentTitle + summary: Gets the title of the revised document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'revisedDocumentTitle?: string;' + return: + type: string + - name: saved + uid: word!Word.Interfaces.DocumentData#saved:member + package: word! + fullName: saved + summary: >- + 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. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'saved?: boolean;' + return: + type: boolean + - name: saveEncoding + uid: word!Word.Interfaces.DocumentData#saveEncoding:member + package: word! + fullName: saveEncoding + summary: Specifies the encoding used when saving the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: saveFormat + uid: word!Word.Interfaces.DocumentData#saveFormat:member + package: word! + fullName: saveFormat + summary: Gets the file format of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | + "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | + "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | + "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | + "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | + "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | + "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | + "StrictOpenXmlDocument"; + return: + type: >- + | "Document" | "Template" + | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" + | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | + "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | + "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | + "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | + "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | + "StrictOpenXmlDocument" + - name: sections + uid: word!Word.Interfaces.DocumentData#sections:member + package: word! + fullName: sections + summary: Gets the collection of section objects in the document. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'sections?: Word.Interfaces.SectionData[];' + return: + type: [] + - name: selection + uid: word!Word.Interfaces.DocumentData#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionData;' + return: + type: + - name: settings + uid: word!Word.Interfaces.DocumentData#settings:member + package: word! + fullName: settings + summary: Gets the add-in's settings in the document. remarks: >- \[ [API set: WordApi 1.4](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -372,6 +1833,210 @@ properties: content: 'settings?: Word.Interfaces.SettingData[];' return: type: [] + - name: textEncoding + uid: word!Word.Interfaces.DocumentData#textEncoding:member + package: word! + fullName: textEncoding + summary: Specifies the encoding for saving as encoded text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: textLineEnding + uid: word!Word.Interfaces.DocumentData#textLineEnding:member + package: word! + fullName: textLineEnding + summary: Specifies how Word marks line and paragraph breaks in text files. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | + "Lfcr" | "Lsps"; + return: + type: >- + | "Crlf" | "CrOnly" | + "LfOnly" | "Lfcr" | "Lsps" + - name: trackedChangesAreDateAndTimeRemoved + uid: >- + word!Word.Interfaces.DocumentData#trackedChangesAreDateAndTimeRemoved:member + package: word! + fullName: trackedChangesAreDateAndTimeRemoved + summary: >- + Specifies whether to remove or store date and time metadata for tracked + changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackedChangesAreDateAndTimeRemoved?: boolean;' + return: + type: boolean + - name: trackFormatting + uid: word!Word.Interfaces.DocumentData#trackFormatting:member + package: word! + fullName: trackFormatting + summary: Specifies whether to track formatting changes when change tracking is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackFormatting?: boolean;' + return: + type: boolean + - name: trackMoves + uid: word!Word.Interfaces.DocumentData#trackMoves:member + package: word! + fullName: trackMoves + summary: Specifies whether to mark moved text when Track Changes is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackMoves?: boolean;' + return: + type: boolean + - name: trackRevisions + uid: word!Word.Interfaces.DocumentData#trackRevisions:member + package: word! + fullName: trackRevisions + summary: Specifies whether changes are tracked in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackRevisions?: boolean;' + return: + type: boolean + - name: type + uid: word!Word.Interfaces.DocumentData#type:member + package: word! + fullName: type + summary: Gets the document type (template or document). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: Word.DocumentType | "Document" | "Template" | "Frameset";' + return: + type: >- + | "Document" | "Template" | + "Frameset" - name: windows uid: word!Word.Interfaces.DocumentData#windows:member package: word! @@ -387,3 +2052,69 @@ properties: content: 'windows?: Word.Interfaces.WindowData[];' return: type: [] + - name: writePassword + uid: word!Word.Interfaces.DocumentData#writePassword:member + package: word! + fullName: writePassword + summary: Sets a password for saving changes to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'writePassword?: string;' + return: + type: string + - name: xmlAreAdvancedErrorsShown + uid: word!Word.Interfaces.DocumentData#xmlAreAdvancedErrorsShown:member + package: word! + fullName: xmlAreAdvancedErrorsShown + summary: >- + Specifies whether error messages are generated from built-in Word messages + or MSXML (Microsoft XML). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlAreAdvancedErrorsShown?: boolean;' + return: + type: boolean + - name: xmlIsXsltUsedWhenSaving + uid: word!Word.Interfaces.DocumentData#xmlIsXsltUsedWhenSaving:member + package: word! + fullName: xmlIsXsltUsedWhenSaving + summary: >- + Specifies whether to save a document through an Extensible Stylesheet + Language Transformation (XSLT). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlIsXsltUsedWhenSaving?: boolean;' + return: + type: boolean + - name: xmlSaveThroughXSLT + uid: word!Word.Interfaces.DocumentData#xmlSaveThroughXSLT:member + package: word! + fullName: xmlSaveThroughXSLT + summary: >- + Specifies the path and file name for the XSLT to apply when saving a + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlSaveThroughXSLT?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml index eb58045f52..5e747fec1b 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml @@ -31,6 +31,36 @@ properties: content: '$all?: boolean;' return: type: boolean + - name: activeTheme + uid: word!Word.Interfaces.DocumentLoadOptions#activeTheme:member + package: word! + fullName: activeTheme + summary: Gets the name of the active theme and formatting options. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activeTheme?: boolean;' + return: + type: boolean + - name: activeThemeDisplayName + uid: word!Word.Interfaces.DocumentLoadOptions#activeThemeDisplayName:member + package: word! + fullName: activeThemeDisplayName + summary: Gets the display name of the active theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'activeThemeDisplayName?: boolean;' + return: + type: boolean - name: activeWindow uid: word!Word.Interfaces.DocumentLoadOptions#activeWindow:member package: word! @@ -46,6 +76,126 @@ properties: content: 'activeWindow?: Word.Interfaces.WindowLoadOptions;' return: type: + - name: areFilePropertiesPasswordEncrypted + uid: >- + word!Word.Interfaces.DocumentLoadOptions#areFilePropertiesPasswordEncrypted:member + package: word! + fullName: areFilePropertiesPasswordEncrypted + summary: >- + Gets whether Word encrypts file properties for password-protected + documents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFilePropertiesPasswordEncrypted?: boolean;' + return: + type: boolean + - name: areGrammaticalErrorsShown + uid: word!Word.Interfaces.DocumentLoadOptions#areGrammaticalErrorsShown:member + package: word! + fullName: areGrammaticalErrorsShown + summary: >- + Specifies whether grammatical errors are marked by a wavy green line in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areGrammaticalErrorsShown?: boolean;' + return: + type: boolean + - name: areMathDefaultsUsed + uid: word!Word.Interfaces.DocumentLoadOptions#areMathDefaultsUsed:member + package: word! + fullName: areMathDefaultsUsed + summary: >- + Specifies whether to use the default math settings when creating new + equations. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areMathDefaultsUsed?: boolean;' + return: + type: boolean + - name: areNewerFeaturesDisabled + uid: word!Word.Interfaces.DocumentLoadOptions#areNewerFeaturesDisabled:member + package: word! + fullName: areNewerFeaturesDisabled + summary: >- + Specifies whether to disable features introduced after a specified + version. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areNewerFeaturesDisabled?: boolean;' + return: + type: boolean + - name: areSpellingErrorsShown + uid: word!Word.Interfaces.DocumentLoadOptions#areSpellingErrorsShown:member + package: word! + fullName: areSpellingErrorsShown + summary: >- + Specifies whether Microsoft Word underlines spelling errors in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areSpellingErrorsShown?: boolean;' + return: + type: boolean + - name: areStylesUpdatedOnOpen + uid: word!Word.Interfaces.DocumentLoadOptions#areStylesUpdatedOnOpen:member + package: word! + fullName: areStylesUpdatedOnOpen + summary: >- + Specifies whether the styles in this document are updated to match the + styles in the attached template each time the document is opened. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areStylesUpdatedOnOpen?: boolean;' + return: + type: boolean + - name: areTrueTypeFontsEmbedded + uid: word!Word.Interfaces.DocumentLoadOptions#areTrueTypeFontsEmbedded:member + package: word! + fullName: areTrueTypeFontsEmbedded + summary: >- + Specifies whether Microsoft Word embeds TrueType fonts in the document + when it's saved. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areTrueTypeFontsEmbedded?: boolean;' + return: + type: boolean - name: attachedTemplate uid: word!Word.Interfaces.DocumentLoadOptions#attachedTemplate:member package: word! @@ -93,6 +243,23 @@ properties: content: 'autoSaveOn?: boolean;' return: type: boolean + - name: background + uid: word!Word.Interfaces.DocumentLoadOptions#background:member + package: word! + fullName: background + summary: >- + Gets a `Shape` object that represents the background image for the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'background?: Word.Interfaces.ShapeLoadOptions;' + return: + type: - name: bibliography uid: word!Word.Interfaces.DocumentLoadOptions#bibliography:member package: word! @@ -127,6 +294,27 @@ properties: content: 'body?: Word.Interfaces.BodyLoadOptions;' return: type: + - name: builtInDocumentProperties + uid: word!Word.Interfaces.DocumentLoadOptions#builtInDocumentProperties:member + package: word! + fullName: builtInDocumentProperties + summary: >- + Gets a `DocumentProperties` object that represents all the built-in + document properties for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + builtInDocumentProperties?: + Word.Interfaces.DocumentPropertiesLoadOptions; + return: + type: >- + - name: changeTrackingMode uid: word!Word.Interfaces.DocumentLoadOptions#changeTrackingMode:member package: word! @@ -157,6 +345,36 @@ properties: content: 'coauthoring?: Word.Interfaces.CoauthoringLoadOptions;' return: type: + - name: codeName + uid: word!Word.Interfaces.DocumentLoadOptions#codeName:member + package: word! + fullName: codeName + summary: Gets the code name for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'codeName?: boolean;' + return: + type: boolean + - name: compatibilityMode + uid: word!Word.Interfaces.DocumentLoadOptions#compatibilityMode:member + package: word! + fullName: compatibilityMode + summary: Gets the compatibility mode that Word uses when opening the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'compatibilityMode?: boolean;' + return: + type: boolean - name: consecutiveHyphensLimit uid: word!Word.Interfaces.DocumentLoadOptions#consecutiveHyphensLimit:member package: word! @@ -174,11 +392,11 @@ properties: content: 'consecutiveHyphensLimit?: boolean;' return: type: boolean - - name: hyphenateCaps - uid: word!Word.Interfaces.DocumentLoadOptions#hyphenateCaps:member + - name: content + uid: word!Word.Interfaces.DocumentLoadOptions#content:member package: word! - fullName: hyphenateCaps - summary: Specifies whether words in all capital letters can be hyphenated. + fullName: content + summary: Gets a `Range` object that represents the main document story. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -186,16 +404,31 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'hyphenateCaps?: boolean;' + content: 'content?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: currentRsid + uid: word!Word.Interfaces.DocumentLoadOptions#currentRsid:member + package: word! + fullName: currentRsid + summary: Gets a random number that Word assigns to changes in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'currentRsid?: boolean;' return: type: boolean - - name: languageDetected - uid: word!Word.Interfaces.DocumentLoadOptions#languageDetected:member + - name: customDocumentProperties + uid: word!Word.Interfaces.DocumentLoadOptions#customDocumentProperties:member package: word! - fullName: languageDetected + fullName: customDocumentProperties summary: >- - Specifies whether Microsoft Word has detected the language of the document - text. + Gets a `DocumentProperties` collection that represents all the custom + document properties for the document. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -203,14 +436,35 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'languageDetected?: boolean;' + content: >- + customDocumentProperties?: + Word.Interfaces.DocumentPropertiesLoadOptions; + return: + type: >- + + - name: defaultTabStop + uid: word!Word.Interfaces.DocumentLoadOptions#defaultTabStop:member + package: word! + fullName: defaultTabStop + summary: >- + Specifies the interval (in points) between the default tab stops in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'defaultTabStop?: boolean;' return: type: boolean - - name: pageSetup - uid: word!Word.Interfaces.DocumentLoadOptions#pageSetup:member + - name: defaultTargetFrame + uid: word!Word.Interfaces.DocumentLoadOptions#defaultTargetFrame:member package: word! - fullName: pageSetup - summary: Returns a `PageSetup` object that's associated with the document. + fullName: defaultTargetFrame + summary: Specifies the browser frame for displaying a webpage via hyperlink. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -218,50 +472,78 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'pageSetup?: Word.Interfaces.PageSetupLoadOptions;' + content: 'defaultTargetFrame?: boolean;' return: - type: - - name: properties - uid: word!Word.Interfaces.DocumentLoadOptions#properties:member + type: boolean + - name: doNotEmbedSystemFonts + uid: word!Word.Interfaces.DocumentLoadOptions#doNotEmbedSystemFonts:member package: word! - fullName: properties - summary: Gets the properties of the document. + fullName: doNotEmbedSystemFonts + summary: Specifies whether Word should not embed common system fonts. remarks: >- - \[ [API set: WordApi - 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'properties?: Word.Interfaces.DocumentPropertiesLoadOptions;' + content: 'doNotEmbedSystemFonts?: boolean;' return: - type: >- - - - name: saved - uid: word!Word.Interfaces.DocumentLoadOptions#saved:member + type: boolean + - name: encryptionProvider + uid: word!Word.Interfaces.DocumentLoadOptions#encryptionProvider:member package: word! - fullName: saved + fullName: encryptionProvider summary: >- - 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. + Specifies the name of the algorithm encryption provider that Microsoft + Word uses when encrypting documents. remarks: >- - \[ [API set: WordApi - 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'saved?: boolean;' + content: 'encryptionProvider?: boolean;' return: type: boolean - - name: selection - uid: word!Word.Interfaces.DocumentLoadOptions#selection:member + - name: farEastLineBreakLanguage + uid: word!Word.Interfaces.DocumentLoadOptions#farEastLineBreakLanguage:member package: word! - fullName: selection + fullName: farEastLineBreakLanguage + summary: Specifies the East Asian language used for line breaking. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'farEastLineBreakLanguage?: boolean;' + return: + type: boolean + - name: farEastLineBreakLevel + uid: word!Word.Interfaces.DocumentLoadOptions#farEastLineBreakLevel:member + package: word! + fullName: farEastLineBreakLevel + summary: Specifies the line break control level. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'farEastLineBreakLevel?: boolean;' + return: + type: boolean + - name: formattingIsNextLevelShown + uid: word!Word.Interfaces.DocumentLoadOptions#formattingIsNextLevelShown:member + package: word! + fullName: formattingIsNextLevelShown summary: >- - Returns a `Selection` object that represents the current selection in the - document. + Specifies whether Word shows the next heading level when the previous is + used. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -269,6 +551,1238 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'selection?: Word.Interfaces.SelectionLoadOptions;' + content: 'formattingIsNextLevelShown?: boolean;' return: - type: + type: boolean + - name: formattingIsUserStyleNameShown + uid: >- + word!Word.Interfaces.DocumentLoadOptions#formattingIsUserStyleNameShown:member + package: word! + fullName: formattingIsUserStyleNameShown + summary: Specifies whether to show user-defined styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formattingIsUserStyleNameShown?: boolean;' + return: + type: boolean + - name: fullName + uid: word!Word.Interfaces.DocumentLoadOptions#fullName:member + package: word! + fullName: fullName + summary: Gets the name of a document, including the path. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fullName?: boolean;' + return: + type: boolean + - name: gridDistanceHorizontal + uid: word!Word.Interfaces.DocumentLoadOptions#gridDistanceHorizontal:member + package: word! + fullName: gridDistanceHorizontal + summary: >- + Specifies the horizontal space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridDistanceHorizontal?: boolean;' + return: + type: boolean + - name: gridDistanceVertical + uid: word!Word.Interfaces.DocumentLoadOptions#gridDistanceVertical:member + package: word! + fullName: gridDistanceVertical + summary: >- + Specifies the vertical space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridDistanceVertical?: boolean;' + return: + type: boolean + - name: gridIsOriginFromMargin + uid: word!Word.Interfaces.DocumentLoadOptions#gridIsOriginFromMargin:member + package: word! + fullName: gridIsOriginFromMargin + summary: >- + Specifies whether the character grid starts from the upper-left corner of + the page. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridIsOriginFromMargin?: boolean;' + return: + type: boolean + - name: gridOriginHorizontal + uid: word!Word.Interfaces.DocumentLoadOptions#gridOriginHorizontal:member + package: word! + fullName: gridOriginHorizontal + summary: Specifies the horizontal origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginHorizontal?: boolean;' + return: + type: boolean + - name: gridOriginVertical + uid: word!Word.Interfaces.DocumentLoadOptions#gridOriginVertical:member + package: word! + fullName: gridOriginVertical + summary: Specifies the vertical origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginVertical?: boolean;' + return: + type: boolean + - name: gridSpaceBetweenHorizontalLines + uid: >- + word!Word.Interfaces.DocumentLoadOptions#gridSpaceBetweenHorizontalLines:member + package: word! + fullName: gridSpaceBetweenHorizontalLines + summary: >- + Specifies the interval for horizontal character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenHorizontalLines?: boolean;' + return: + type: boolean + - name: gridSpaceBetweenVerticalLines + uid: >- + word!Word.Interfaces.DocumentLoadOptions#gridSpaceBetweenVerticalLines:member + package: word! + fullName: gridSpaceBetweenVerticalLines + summary: >- + Specifies the interval for vertical character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenVerticalLines?: boolean;' + return: + type: boolean + - name: hasPassword + uid: word!Word.Interfaces.DocumentLoadOptions#hasPassword:member + package: word! + fullName: hasPassword + summary: Gets whether a password is required to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasPassword?: boolean;' + return: + type: boolean + - name: hasVbProject + uid: word!Word.Interfaces.DocumentLoadOptions#hasVbProject:member + package: word! + fullName: hasVbProject + summary: >- + Gets whether the document has an attached Microsoft Visual Basic for + Applications project. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasVbProject?: boolean;' + return: + type: boolean + - name: hyphenateCaps + uid: word!Word.Interfaces.DocumentLoadOptions#hyphenateCaps:member + package: word! + fullName: hyphenateCaps + summary: Specifies whether words in all capital letters can be hyphenated. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenateCaps?: boolean;' + return: + type: boolean + - name: hyphenationZone + uid: word!Word.Interfaces.DocumentLoadOptions#hyphenationZone:member + package: word! + fullName: hyphenationZone + summary: Specifies the width of the hyphenation zone, in points. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyphenationZone?: boolean;' + return: + type: boolean + - name: isAutoFormatOverrideOn + uid: word!Word.Interfaces.DocumentLoadOptions#isAutoFormatOverrideOn:member + package: word! + fullName: isAutoFormatOverrideOn + summary: >- + Specifies whether automatic formatting options override formatting + restrictions. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isAutoFormatOverrideOn?: boolean;' + return: + type: boolean + - name: isChartDataPointTracked + uid: word!Word.Interfaces.DocumentLoadOptions#isChartDataPointTracked:member + package: word! + fullName: isChartDataPointTracked + summary: >- + Specifies whether charts in the active document use cell-reference + data-point tracking. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isChartDataPointTracked?: boolean;' + return: + type: boolean + - name: isCompatible + uid: word!Word.Interfaces.DocumentLoadOptions#isCompatible:member + package: word! + fullName: isCompatible + summary: >- + Specifies whether the compatibility option specified by the `type` + property is enabled. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCompatible?: boolean;' + return: + type: boolean + - name: isFinal + uid: word!Word.Interfaces.DocumentLoadOptions#isFinal:member + package: word! + fullName: isFinal + summary: Specifies whether the document is final. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFinal?: boolean;' + return: + type: boolean + - name: isFontsSubsetSaved + uid: word!Word.Interfaces.DocumentLoadOptions#isFontsSubsetSaved:member + package: word! + fullName: isFontsSubsetSaved + summary: >- + Specifies whether Microsoft Word saves a subset of the embedded TrueType + fonts with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFontsSubsetSaved?: boolean;' + return: + type: boolean + - name: isFormsDataPrinted + uid: word!Word.Interfaces.DocumentLoadOptions#isFormsDataPrinted:member + package: word! + fullName: isFormsDataPrinted + summary: >- + Specifies whether Microsoft Word prints onto a preprinted form only the + data entered in the corresponding online form. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataPrinted?: boolean;' + return: + type: boolean + - name: isFormsDataSaved + uid: word!Word.Interfaces.DocumentLoadOptions#isFormsDataSaved:member + package: word! + fullName: isFormsDataSaved + summary: >- + Specifies whether Microsoft Word saves the data entered in a form as a + tab-delimited record for use in a database. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataSaved?: boolean;' + return: + type: boolean + - name: isGrammarChecked + uid: word!Word.Interfaces.DocumentLoadOptions#isGrammarChecked:member + package: word! + fullName: isGrammarChecked + summary: Specifies whether a grammar check has been run on the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isGrammarChecked?: boolean;' + return: + type: boolean + - name: isInAutoSave + uid: word!Word.Interfaces.DocumentLoadOptions#isInAutoSave:member + package: word! + fullName: isInAutoSave + summary: >- + Gets whether the most recent firing of the + `Application.DocumentBeforeSave` event was the result of an automatic save + by the document or a manual save by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInAutoSave?: boolean;' + return: + type: boolean + - name: isInFormsDesign + uid: word!Word.Interfaces.DocumentLoadOptions#isInFormsDesign:member + package: word! + fullName: isInFormsDesign + summary: Gets whether the document is in form design mode. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInFormsDesign?: boolean;' + return: + type: boolean + - name: isKerningByAlgorithm + uid: word!Word.Interfaces.DocumentLoadOptions#isKerningByAlgorithm:member + package: word! + fullName: isKerningByAlgorithm + summary: >- + Specifies whether Word kerns half-width Latin characters and punctuation + marks. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isKerningByAlgorithm?: boolean;' + return: + type: boolean + - name: isLinguisticDataEmbedded + uid: word!Word.Interfaces.DocumentLoadOptions#isLinguisticDataEmbedded:member + package: word! + fullName: isLinguisticDataEmbedded + summary: Specifies whether to embed speech and handwriting data. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLinguisticDataEmbedded?: boolean;' + return: + type: boolean + - name: isMasterDocument + uid: word!Word.Interfaces.DocumentLoadOptions#isMasterDocument:member + package: word! + fullName: isMasterDocument + summary: Gets whether this document is a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isMasterDocument?: boolean;' + return: + type: boolean + - name: isOptimizedForWord97 + uid: word!Word.Interfaces.DocumentLoadOptions#isOptimizedForWord97:member + package: word! + fullName: isOptimizedForWord97 + summary: Specifies whether Word optimizes the document for Word 97. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isOptimizedForWord97?: boolean;' + return: + type: boolean + - name: isPostScriptPrintedOverText + uid: >- + word!Word.Interfaces.DocumentLoadOptions#isPostScriptPrintedOverText:member + package: word! + fullName: isPostScriptPrintedOverText + summary: >- + Specifies whether [PRINT + field](https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f) + instructions (such as PostScript commands) in the document are to be + printed on top of text and graphics when a PostScript printer is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPostScriptPrintedOverText?: boolean;' + return: + type: boolean + - name: isQuickStyleSetLocked + uid: word!Word.Interfaces.DocumentLoadOptions#isQuickStyleSetLocked:member + package: word! + fullName: isQuickStyleSetLocked + summary: Specifies whether users can change the Quick Style set. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isQuickStyleSetLocked?: boolean;' + return: + type: boolean + - name: isReadOnly + uid: word!Word.Interfaces.DocumentLoadOptions#isReadOnly:member + package: word! + fullName: isReadOnly + summary: >- + Gets whether changes to the document cannot be saved to the original + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnly?: boolean;' + return: + type: boolean + - name: isReadOnlyRecommended + uid: word!Word.Interfaces.DocumentLoadOptions#isReadOnlyRecommended:member + package: word! + fullName: isReadOnlyRecommended + summary: >- + Specifies whether Microsoft Word displays a message box whenever a user + opens the document, suggesting that it be opened as read-only. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnlyRecommended?: boolean;' + return: + type: boolean + - name: isSnappedToGrid + uid: word!Word.Interfaces.DocumentLoadOptions#isSnappedToGrid:member + package: word! + fullName: isSnappedToGrid + summary: >- + Specifies whether AutoShapes or East Asian characters are automatically + aligned with an invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToGrid?: boolean;' + return: + type: boolean + - name: isSnappedToShapes + uid: word!Word.Interfaces.DocumentLoadOptions#isSnappedToShapes:member + package: word! + fullName: isSnappedToShapes + summary: >- + Specifies whether AutoShapes or East Asian characters align with invisible + gridlines through other shapes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToShapes?: boolean;' + return: + type: boolean + - name: isSpellingChecked + uid: word!Word.Interfaces.DocumentLoadOptions#isSpellingChecked:member + package: word! + fullName: isSpellingChecked + summary: Specifies whether spelling has been checked throughout the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSpellingChecked?: boolean;' + return: + type: boolean + - name: isStyleEnforced + uid: word!Word.Interfaces.DocumentLoadOptions#isStyleEnforced:member + package: word! + fullName: isStyleEnforced + summary: >- + Specifies whether formatting restrictions are enforced in a protected + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStyleEnforced?: boolean;' + return: + type: boolean + - name: isSubdocument + uid: word!Word.Interfaces.DocumentLoadOptions#isSubdocument:member + package: word! + fullName: isSubdocument + summary: Gets whether this document is a subdocument of a master document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSubdocument?: boolean;' + return: + type: boolean + - name: isThemeLocked + uid: word!Word.Interfaces.DocumentLoadOptions#isThemeLocked:member + package: word! + fullName: isThemeLocked + summary: Specifies whether users can change the document theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isThemeLocked?: boolean;' + return: + type: boolean + - name: isUserControl + uid: word!Word.Interfaces.DocumentLoadOptions#isUserControl:member + package: word! + fullName: isUserControl + summary: Specifies whether the document was created or opened by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isUserControl?: boolean;' + return: + type: boolean + - name: isVbaSigned + uid: word!Word.Interfaces.DocumentLoadOptions#isVbaSigned:member + package: word! + fullName: isVbaSigned + summary: Gets whether the VBA project is digitally signed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isVbaSigned?: boolean;' + return: + type: boolean + - name: isWriteReserved + uid: word!Word.Interfaces.DocumentLoadOptions#isWriteReserved:member + package: word! + fullName: isWriteReserved + summary: Gets whether the document is protected with a write password. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isWriteReserved?: boolean;' + return: + type: boolean + - name: justificationMode + uid: word!Word.Interfaces.DocumentLoadOptions#justificationMode:member + package: word! + fullName: justificationMode + summary: Specifies the character spacing adjustment. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'justificationMode?: boolean;' + return: + type: boolean + - name: kind + uid: word!Word.Interfaces.DocumentLoadOptions#kind:member + package: word! + fullName: kind + summary: >- + Specifies the format type that Microsoft Word uses when automatically + formatting the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'kind?: boolean;' + return: + type: boolean + - name: languageDetected + uid: word!Word.Interfaces.DocumentLoadOptions#languageDetected:member + package: word! + fullName: languageDetected + summary: >- + Specifies whether Microsoft Word has detected the language of the document + text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: noLineBreakAfter + uid: word!Word.Interfaces.DocumentLoadOptions#noLineBreakAfter:member + package: word! + fullName: noLineBreakAfter + summary: Specifies the kinsoku characters after which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakAfter?: boolean;' + return: + type: boolean + - name: noLineBreakBefore + uid: word!Word.Interfaces.DocumentLoadOptions#noLineBreakBefore:member + package: word! + fullName: noLineBreakBefore + summary: Specifies the kinsoku characters before which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakBefore?: boolean;' + return: + type: boolean + - name: openEncoding + uid: word!Word.Interfaces.DocumentLoadOptions#openEncoding:member + package: word! + fullName: openEncoding + summary: Gets the encoding used to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'openEncoding?: boolean;' + return: + type: boolean + - name: originalDocumentTitle + uid: word!Word.Interfaces.DocumentLoadOptions#originalDocumentTitle:member + package: word! + fullName: originalDocumentTitle + summary: Gets the title of the original document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'originalDocumentTitle?: boolean;' + return: + type: boolean + - name: pageSetup + uid: word!Word.Interfaces.DocumentLoadOptions#pageSetup:member + package: word! + fullName: pageSetup + summary: Returns a `PageSetup` object that's associated with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageSetup?: Word.Interfaces.PageSetupLoadOptions;' + return: + type: + - name: password + uid: word!Word.Interfaces.DocumentLoadOptions#password:member + package: word! + fullName: password + summary: Sets a password that must be supplied to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'password?: boolean;' + return: + type: boolean + - name: passwordEncryptionAlgorithm + uid: >- + word!Word.Interfaces.DocumentLoadOptions#passwordEncryptionAlgorithm:member + package: word! + fullName: passwordEncryptionAlgorithm + summary: Gets the algorithm used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionAlgorithm?: boolean;' + return: + type: boolean + - name: passwordEncryptionKeyLength + uid: >- + word!Word.Interfaces.DocumentLoadOptions#passwordEncryptionKeyLength:member + package: word! + fullName: passwordEncryptionKeyLength + summary: Gets the key length used for password encryption. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionKeyLength?: boolean;' + return: + type: boolean + - name: passwordEncryptionProvider + uid: word!Word.Interfaces.DocumentLoadOptions#passwordEncryptionProvider:member + package: word! + fullName: passwordEncryptionProvider + summary: Gets the name of the password encryption provider. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'passwordEncryptionProvider?: boolean;' + return: + type: boolean + - name: path + uid: word!Word.Interfaces.DocumentLoadOptions#path:member + package: word! + fullName: path + summary: >- + Gets the disk or the web path to the document (excludes the document + name). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'path?: boolean;' + return: + type: boolean + - name: printRevisions + uid: word!Word.Interfaces.DocumentLoadOptions#printRevisions:member + package: word! + fullName: printRevisions + summary: Specifies whether revision marks are printed with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printRevisions?: boolean;' + return: + type: boolean + - name: properties + uid: word!Word.Interfaces.DocumentLoadOptions#properties:member + package: word! + fullName: properties + summary: Gets the properties of the document. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Word.Interfaces.DocumentPropertiesLoadOptions;' + return: + type: >- + + - name: protectionType + uid: word!Word.Interfaces.DocumentLoadOptions#protectionType:member + package: word! + fullName: protectionType + summary: Gets the protection type for the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'protectionType?: boolean;' + return: + type: boolean + - name: readingLayoutSizeX + uid: word!Word.Interfaces.DocumentLoadOptions#readingLayoutSizeX:member + package: word! + fullName: readingLayoutSizeX + summary: Specifies the width of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeX?: boolean;' + return: + type: boolean + - name: readingLayoutSizeY + uid: word!Word.Interfaces.DocumentLoadOptions#readingLayoutSizeY:member + package: word! + fullName: readingLayoutSizeY + summary: Specifies the height of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeY?: boolean;' + return: + type: boolean + - name: readingModeIsLayoutFrozen + uid: word!Word.Interfaces.DocumentLoadOptions#readingModeIsLayoutFrozen:member + package: word! + fullName: readingModeIsLayoutFrozen + summary: >- + Specifies whether pages in reading layout view are frozen for handwritten + markup. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingModeIsLayoutFrozen?: boolean;' + return: + type: boolean + - name: removePersonalInformationOnSave + uid: >- + word!Word.Interfaces.DocumentLoadOptions#removePersonalInformationOnSave:member + package: word! + fullName: removePersonalInformationOnSave + summary: Specifies whether Word removes user information upon saving. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removePersonalInformationOnSave?: boolean;' + return: + type: boolean + - name: revisedDocumentTitle + uid: word!Word.Interfaces.DocumentLoadOptions#revisedDocumentTitle:member + package: word! + fullName: revisedDocumentTitle + summary: Gets the title of the revised document after legal-blackline comparison. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'revisedDocumentTitle?: boolean;' + return: + type: boolean + - name: saved + uid: word!Word.Interfaces.DocumentLoadOptions#saved:member + package: word! + fullName: saved + summary: >- + 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. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'saved?: boolean;' + return: + type: boolean + - name: saveEncoding + uid: word!Word.Interfaces.DocumentLoadOptions#saveEncoding:member + package: word! + fullName: saveEncoding + summary: Specifies the encoding used when saving the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'saveEncoding?: boolean;' + return: + type: boolean + - name: saveFormat + uid: word!Word.Interfaces.DocumentLoadOptions#saveFormat:member + package: word! + fullName: saveFormat + summary: Gets the file format of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'saveFormat?: boolean;' + return: + type: boolean + - name: selection + uid: word!Word.Interfaces.DocumentLoadOptions#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionLoadOptions;' + return: + type: + - name: textEncoding + uid: word!Word.Interfaces.DocumentLoadOptions#textEncoding:member + package: word! + fullName: textEncoding + summary: Specifies the encoding for saving as encoded text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'textEncoding?: boolean;' + return: + type: boolean + - name: textLineEnding + uid: word!Word.Interfaces.DocumentLoadOptions#textLineEnding:member + package: word! + fullName: textLineEnding + summary: Specifies how Word marks line and paragraph breaks in text files. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'textLineEnding?: boolean;' + return: + type: boolean + - name: trackedChangesAreDateAndTimeRemoved + uid: >- + word!Word.Interfaces.DocumentLoadOptions#trackedChangesAreDateAndTimeRemoved:member + package: word! + fullName: trackedChangesAreDateAndTimeRemoved + summary: >- + Specifies whether to remove or store date and time metadata for tracked + changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackedChangesAreDateAndTimeRemoved?: boolean;' + return: + type: boolean + - name: trackFormatting + uid: word!Word.Interfaces.DocumentLoadOptions#trackFormatting:member + package: word! + fullName: trackFormatting + summary: Specifies whether to track formatting changes when change tracking is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackFormatting?: boolean;' + return: + type: boolean + - name: trackMoves + uid: word!Word.Interfaces.DocumentLoadOptions#trackMoves:member + package: word! + fullName: trackMoves + summary: Specifies whether to mark moved text when Track Changes is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackMoves?: boolean;' + return: + type: boolean + - name: trackRevisions + uid: word!Word.Interfaces.DocumentLoadOptions#trackRevisions:member + package: word! + fullName: trackRevisions + summary: Specifies whether changes are tracked in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackRevisions?: boolean;' + return: + type: boolean + - name: type + uid: word!Word.Interfaces.DocumentLoadOptions#type:member + package: word! + fullName: type + summary: Gets the document type (template or document). + 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: webSettings + uid: word!Word.Interfaces.DocumentLoadOptions#webSettings:member + package: word! + fullName: webSettings + summary: Gets the `WebSettings` object for webpage-related attributes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'webSettings?: Word.Interfaces.WebSettingsLoadOptions;' + return: + type: + - name: writePassword + uid: word!Word.Interfaces.DocumentLoadOptions#writePassword:member + package: word! + fullName: writePassword + summary: Sets a password for saving changes to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'writePassword?: boolean;' + return: + type: boolean + - name: xmlAreAdvancedErrorsShown + uid: word!Word.Interfaces.DocumentLoadOptions#xmlAreAdvancedErrorsShown:member + package: word! + fullName: xmlAreAdvancedErrorsShown + summary: >- + Specifies whether error messages are generated from built-in Word messages + or MSXML (Microsoft XML). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlAreAdvancedErrorsShown?: boolean;' + return: + type: boolean + - name: xmlIsXsltUsedWhenSaving + uid: word!Word.Interfaces.DocumentLoadOptions#xmlIsXsltUsedWhenSaving:member + package: word! + fullName: xmlIsXsltUsedWhenSaving + summary: >- + Specifies whether to save a document through an Extensible Stylesheet + Language Transformation (XSLT). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlIsXsltUsedWhenSaving?: boolean;' + return: + type: boolean + - name: xmlSaveThroughXSLT + uid: word!Word.Interfaces.DocumentLoadOptions#xmlSaveThroughXSLT:member + package: word! + fullName: xmlSaveThroughXSLT + summary: >- + Specifies the path and file name for the XSLT to apply when saving a + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlSaveThroughXSLT?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.documentupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.documentupdatedata.yml index 099ee71322..a80b1b2857 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.documentupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.documentupdatedata.yml @@ -27,6 +27,108 @@ properties: content: 'activeWindow?: Word.Interfaces.WindowUpdateData;' return: type: + - name: areGrammaticalErrorsShown + uid: word!Word.Interfaces.DocumentUpdateData#areGrammaticalErrorsShown:member + package: word! + fullName: areGrammaticalErrorsShown + summary: >- + Specifies whether grammatical errors are marked by a wavy green line in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areGrammaticalErrorsShown?: boolean;' + return: + type: boolean + - name: areMathDefaultsUsed + uid: word!Word.Interfaces.DocumentUpdateData#areMathDefaultsUsed:member + package: word! + fullName: areMathDefaultsUsed + summary: >- + Specifies whether to use the default math settings when creating new + equations. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areMathDefaultsUsed?: boolean;' + return: + type: boolean + - name: areNewerFeaturesDisabled + uid: word!Word.Interfaces.DocumentUpdateData#areNewerFeaturesDisabled:member + package: word! + fullName: areNewerFeaturesDisabled + summary: >- + Specifies whether to disable features introduced after a specified + version. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areNewerFeaturesDisabled?: boolean;' + return: + type: boolean + - name: areSpellingErrorsShown + uid: word!Word.Interfaces.DocumentUpdateData#areSpellingErrorsShown:member + package: word! + fullName: areSpellingErrorsShown + summary: >- + Specifies whether Microsoft Word underlines spelling errors in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areSpellingErrorsShown?: boolean;' + return: + type: boolean + - name: areStylesUpdatedOnOpen + uid: word!Word.Interfaces.DocumentUpdateData#areStylesUpdatedOnOpen:member + package: word! + fullName: areStylesUpdatedOnOpen + summary: >- + Specifies whether the styles in this document are updated to match the + styles in the attached template each time the document is opened. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areStylesUpdatedOnOpen?: boolean;' + return: + type: boolean + - name: areTrueTypeFontsEmbedded + uid: word!Word.Interfaces.DocumentUpdateData#areTrueTypeFontsEmbedded:member + package: word! + fullName: areTrueTypeFontsEmbedded + summary: >- + Specifies whether Microsoft Word embeds TrueType fonts in the document + when it's saved. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areTrueTypeFontsEmbedded?: boolean;' + return: + type: boolean - name: autoHyphenation uid: word!Word.Interfaces.DocumentUpdateData#autoHyphenation:member package: word! @@ -127,6 +229,260 @@ properties: content: 'consecutiveHyphensLimit?: number;' return: type: number + - name: defaultTabStop + uid: word!Word.Interfaces.DocumentUpdateData#defaultTabStop:member + package: word! + fullName: defaultTabStop + summary: >- + Specifies the interval (in points) between the default tab stops in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'defaultTabStop?: number;' + return: + type: number + - name: defaultTargetFrame + uid: word!Word.Interfaces.DocumentUpdateData#defaultTargetFrame:member + package: word! + fullName: defaultTargetFrame + summary: Specifies the browser frame for displaying a webpage via hyperlink. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'defaultTargetFrame?: string;' + return: + type: string + - name: doNotEmbedSystemFonts + uid: word!Word.Interfaces.DocumentUpdateData#doNotEmbedSystemFonts:member + package: word! + fullName: doNotEmbedSystemFonts + summary: Specifies whether Word should not embed common system fonts. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'doNotEmbedSystemFonts?: boolean;' + return: + type: boolean + - name: encryptionProvider + uid: word!Word.Interfaces.DocumentUpdateData#encryptionProvider:member + package: word! + fullName: encryptionProvider + summary: >- + Specifies the name of the algorithm encryption provider that Microsoft + Word uses when encrypting documents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'encryptionProvider?: string;' + return: + type: string + - name: farEastLineBreakLanguage + uid: word!Word.Interfaces.DocumentUpdateData#farEastLineBreakLanguage:member + package: word! + fullName: farEastLineBreakLanguage + summary: Specifies the East Asian language used for line breaking. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + return: + type: >- + | + "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese" + - name: farEastLineBreakLevel + uid: word!Word.Interfaces.DocumentUpdateData#farEastLineBreakLevel:member + package: word! + fullName: farEastLineBreakLevel + summary: Specifies the line break control level. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" + | "Custom"; + return: + type: >- + | "Normal" | + "Strict" | "Custom" + - name: formattingIsNextLevelShown + uid: word!Word.Interfaces.DocumentUpdateData#formattingIsNextLevelShown:member + package: word! + fullName: formattingIsNextLevelShown + summary: >- + Specifies whether Word shows the next heading level when the previous is + used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formattingIsNextLevelShown?: boolean;' + return: + type: boolean + - name: formattingIsUserStyleNameShown + uid: >- + word!Word.Interfaces.DocumentUpdateData#formattingIsUserStyleNameShown:member + package: word! + fullName: formattingIsUserStyleNameShown + summary: Specifies whether to show user-defined styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formattingIsUserStyleNameShown?: boolean;' + return: + type: boolean + - name: gridDistanceHorizontal + uid: word!Word.Interfaces.DocumentUpdateData#gridDistanceHorizontal:member + package: word! + fullName: gridDistanceHorizontal + summary: >- + Specifies the horizontal space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridDistanceHorizontal?: number;' + return: + type: number + - name: gridDistanceVertical + uid: word!Word.Interfaces.DocumentUpdateData#gridDistanceVertical:member + package: word! + fullName: gridDistanceVertical + summary: >- + Specifies the vertical space between invisible gridlines that Microsoft + Word uses when you draw, move, and resize AutoShapes or East Asian + characters in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridDistanceVertical?: number;' + return: + type: number + - name: gridIsOriginFromMargin + uid: word!Word.Interfaces.DocumentUpdateData#gridIsOriginFromMargin:member + package: word! + fullName: gridIsOriginFromMargin + summary: >- + Specifies whether the character grid starts from the upper-left corner of + the page. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridIsOriginFromMargin?: boolean;' + return: + type: boolean + - name: gridOriginHorizontal + uid: word!Word.Interfaces.DocumentUpdateData#gridOriginHorizontal:member + package: word! + fullName: gridOriginHorizontal + summary: Specifies the horizontal origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginHorizontal?: number;' + return: + type: number + - name: gridOriginVertical + uid: word!Word.Interfaces.DocumentUpdateData#gridOriginVertical:member + package: word! + fullName: gridOriginVertical + summary: Specifies the vertical origin point for the invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridOriginVertical?: number;' + return: + type: number + - name: gridSpaceBetweenHorizontalLines + uid: >- + word!Word.Interfaces.DocumentUpdateData#gridSpaceBetweenHorizontalLines:member + package: word! + fullName: gridSpaceBetweenHorizontalLines + summary: >- + Specifies the interval for horizontal character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenHorizontalLines?: number;' + return: + type: number + - name: gridSpaceBetweenVerticalLines + uid: >- + word!Word.Interfaces.DocumentUpdateData#gridSpaceBetweenVerticalLines:member + package: word! + fullName: gridSpaceBetweenVerticalLines + summary: >- + Specifies the interval for vertical character gridlines in print layout + view. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'gridSpaceBetweenVerticalLines?: number;' + return: + type: number - name: hyphenateCaps uid: word!Word.Interfaces.DocumentUpdateData#hyphenateCaps:member package: word! @@ -142,13 +498,11 @@ properties: content: 'hyphenateCaps?: boolean;' return: type: boolean - - name: languageDetected - uid: word!Word.Interfaces.DocumentUpdateData#languageDetected:member + - name: hyphenationZone + uid: word!Word.Interfaces.DocumentUpdateData#hyphenationZone:member package: word! - fullName: languageDetected - summary: >- - Specifies whether Microsoft Word has detected the language of the document - text. + fullName: hyphenationZone + summary: Specifies the width of the hyphenation zone, in points. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -156,14 +510,16 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'languageDetected?: boolean;' + content: 'hyphenationZone?: number;' return: - type: boolean - - name: pageSetup - uid: word!Word.Interfaces.DocumentUpdateData#pageSetup:member + type: number + - name: isAutoFormatOverrideOn + uid: word!Word.Interfaces.DocumentUpdateData#isAutoFormatOverrideOn:member package: word! - fullName: pageSetup - summary: Returns a `PageSetup` object that's associated with the document. + fullName: isAutoFormatOverrideOn + summary: >- + Specifies whether automatic formatting options override formatting + restrictions. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] @@ -171,23 +527,883 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'pageSetup?: Word.Interfaces.PageSetupUpdateData;' + content: 'isAutoFormatOverrideOn?: boolean;' return: - type: - - name: properties - uid: word!Word.Interfaces.DocumentUpdateData#properties:member + type: boolean + - name: isChartDataPointTracked + uid: word!Word.Interfaces.DocumentUpdateData#isChartDataPointTracked:member package: word! - fullName: properties - summary: Gets the properties of the document. + fullName: isChartDataPointTracked + summary: >- + Specifies whether charts in the active document use cell-reference + data-point tracking. remarks: >- - \[ [API set: WordApi - 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - isPreview: false + isPreview: true isDeprecated: false syntax: - content: 'properties?: Word.Interfaces.DocumentPropertiesUpdateData;' + content: 'isChartDataPointTracked?: boolean;' return: - type: >- - + type: boolean + - name: isCompatible + uid: word!Word.Interfaces.DocumentUpdateData#isCompatible:member + package: word! + fullName: isCompatible + summary: >- + Specifies whether the compatibility option specified by the `type` + property is enabled. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCompatible?: boolean;' + return: + type: boolean + - name: isFinal + uid: word!Word.Interfaces.DocumentUpdateData#isFinal:member + package: word! + fullName: isFinal + summary: Specifies whether the document is final. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFinal?: boolean;' + return: + type: boolean + - name: isFontsSubsetSaved + uid: word!Word.Interfaces.DocumentUpdateData#isFontsSubsetSaved:member + package: word! + fullName: isFontsSubsetSaved + summary: >- + Specifies whether Microsoft Word saves a subset of the embedded TrueType + fonts with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFontsSubsetSaved?: boolean;' + return: + type: boolean + - name: isFormsDataPrinted + uid: word!Word.Interfaces.DocumentUpdateData#isFormsDataPrinted:member + package: word! + fullName: isFormsDataPrinted + summary: >- + Specifies whether Microsoft Word prints onto a preprinted form only the + data entered in the corresponding online form. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataPrinted?: boolean;' + return: + type: boolean + - name: isFormsDataSaved + uid: word!Word.Interfaces.DocumentUpdateData#isFormsDataSaved:member + package: word! + fullName: isFormsDataSaved + summary: >- + Specifies whether Microsoft Word saves the data entered in a form as a + tab-delimited record for use in a database. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isFormsDataSaved?: boolean;' + return: + type: boolean + - name: isGrammarChecked + uid: word!Word.Interfaces.DocumentUpdateData#isGrammarChecked:member + package: word! + fullName: isGrammarChecked + summary: Specifies whether a grammar check has been run on the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isGrammarChecked?: boolean;' + return: + type: boolean + - name: isKerningByAlgorithm + uid: word!Word.Interfaces.DocumentUpdateData#isKerningByAlgorithm:member + package: word! + fullName: isKerningByAlgorithm + summary: >- + Specifies whether Word kerns half-width Latin characters and punctuation + marks. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isKerningByAlgorithm?: boolean;' + return: + type: boolean + - name: isLinguisticDataEmbedded + uid: word!Word.Interfaces.DocumentUpdateData#isLinguisticDataEmbedded:member + package: word! + fullName: isLinguisticDataEmbedded + summary: Specifies whether to embed speech and handwriting data. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLinguisticDataEmbedded?: boolean;' + return: + type: boolean + - name: isOptimizedForWord97 + uid: word!Word.Interfaces.DocumentUpdateData#isOptimizedForWord97:member + package: word! + fullName: isOptimizedForWord97 + summary: Specifies whether Word optimizes the document for Word 97. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isOptimizedForWord97?: boolean;' + return: + type: boolean + - name: isPostScriptPrintedOverText + uid: word!Word.Interfaces.DocumentUpdateData#isPostScriptPrintedOverText:member + package: word! + fullName: isPostScriptPrintedOverText + summary: >- + Specifies whether [PRINT + field](https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f) + instructions (such as PostScript commands) in the document are to be + printed on top of text and graphics when a PostScript printer is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPostScriptPrintedOverText?: boolean;' + return: + type: boolean + - name: isQuickStyleSetLocked + uid: word!Word.Interfaces.DocumentUpdateData#isQuickStyleSetLocked:member + package: word! + fullName: isQuickStyleSetLocked + summary: Specifies whether users can change the Quick Style set. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isQuickStyleSetLocked?: boolean;' + return: + type: boolean + - name: isReadOnlyRecommended + uid: word!Word.Interfaces.DocumentUpdateData#isReadOnlyRecommended:member + package: word! + fullName: isReadOnlyRecommended + summary: >- + Specifies whether Microsoft Word displays a message box whenever a user + opens the document, suggesting that it be opened as read-only. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isReadOnlyRecommended?: boolean;' + return: + type: boolean + - name: isSnappedToGrid + uid: word!Word.Interfaces.DocumentUpdateData#isSnappedToGrid:member + package: word! + fullName: isSnappedToGrid + summary: >- + Specifies whether AutoShapes or East Asian characters are automatically + aligned with an invisible grid. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToGrid?: boolean;' + return: + type: boolean + - name: isSnappedToShapes + uid: word!Word.Interfaces.DocumentUpdateData#isSnappedToShapes:member + package: word! + fullName: isSnappedToShapes + summary: >- + Specifies whether AutoShapes or East Asian characters align with invisible + gridlines through other shapes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSnappedToShapes?: boolean;' + return: + type: boolean + - name: isSpellingChecked + uid: word!Word.Interfaces.DocumentUpdateData#isSpellingChecked:member + package: word! + fullName: isSpellingChecked + summary: Specifies whether spelling has been checked throughout the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isSpellingChecked?: boolean;' + return: + type: boolean + - name: isStyleEnforced + uid: word!Word.Interfaces.DocumentUpdateData#isStyleEnforced:member + package: word! + fullName: isStyleEnforced + summary: >- + Specifies whether formatting restrictions are enforced in a protected + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStyleEnforced?: boolean;' + return: + type: boolean + - name: isThemeLocked + uid: word!Word.Interfaces.DocumentUpdateData#isThemeLocked:member + package: word! + fullName: isThemeLocked + summary: Specifies whether users can change the document theme. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isThemeLocked?: boolean;' + return: + type: boolean + - name: isUserControl + uid: word!Word.Interfaces.DocumentUpdateData#isUserControl:member + package: word! + fullName: isUserControl + summary: Specifies whether the document was created or opened by the user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isUserControl?: boolean;' + return: + type: boolean + - name: justificationMode + uid: word!Word.Interfaces.DocumentUpdateData#justificationMode:member + package: word! + fullName: justificationMode + summary: Specifies the character spacing adjustment. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | + "CompressKana"; + return: + type: >- + | "Expand" | + "Compress" | "CompressKana" + - name: kind + uid: word!Word.Interfaces.DocumentUpdateData#kind:member + package: word! + fullName: kind + summary: >- + Specifies the format type that Microsoft Word uses when automatically + formatting the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";' + return: + type: >- + | "NotSpecified" | "Letter" + | "Email" + - name: languageDetected + uid: word!Word.Interfaces.DocumentUpdateData#languageDetected:member + package: word! + fullName: languageDetected + summary: >- + Specifies whether Microsoft Word has detected the language of the document + text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: noLineBreakAfter + uid: word!Word.Interfaces.DocumentUpdateData#noLineBreakAfter:member + package: word! + fullName: noLineBreakAfter + summary: Specifies the kinsoku characters after which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakAfter?: string;' + return: + type: string + - name: noLineBreakBefore + uid: word!Word.Interfaces.DocumentUpdateData#noLineBreakBefore:member + package: word! + fullName: noLineBreakBefore + summary: Specifies the kinsoku characters before which Word will not break a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'noLineBreakBefore?: string;' + return: + type: string + - name: pageSetup + uid: word!Word.Interfaces.DocumentUpdateData#pageSetup:member + package: word! + fullName: pageSetup + summary: Returns a `PageSetup` object that's associated with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageSetup?: Word.Interfaces.PageSetupUpdateData;' + return: + type: + - name: password + uid: word!Word.Interfaces.DocumentUpdateData#password:member + package: word! + fullName: password + summary: Sets a password that must be supplied to open the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'password?: string;' + return: + type: string + - name: printRevisions + uid: word!Word.Interfaces.DocumentUpdateData#printRevisions:member + package: word! + fullName: printRevisions + summary: Specifies whether revision marks are printed with the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'printRevisions?: boolean;' + return: + type: boolean + - name: properties + uid: word!Word.Interfaces.DocumentUpdateData#properties:member + package: word! + fullName: properties + summary: Gets the properties of the document. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'properties?: Word.Interfaces.DocumentPropertiesUpdateData;' + return: + type: >- + + - name: readingLayoutSizeX + uid: word!Word.Interfaces.DocumentUpdateData#readingLayoutSizeX:member + package: word! + fullName: readingLayoutSizeX + summary: Specifies the width of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeX?: number;' + return: + type: number + - name: readingLayoutSizeY + uid: word!Word.Interfaces.DocumentUpdateData#readingLayoutSizeY:member + package: word! + fullName: readingLayoutSizeY + summary: Specifies the height of pages in reading layout view when frozen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingLayoutSizeY?: number;' + return: + type: number + - name: readingModeIsLayoutFrozen + uid: word!Word.Interfaces.DocumentUpdateData#readingModeIsLayoutFrozen:member + package: word! + fullName: readingModeIsLayoutFrozen + summary: >- + Specifies whether pages in reading layout view are frozen for handwritten + markup. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readingModeIsLayoutFrozen?: boolean;' + return: + type: boolean + - name: removePersonalInformationOnSave + uid: >- + word!Word.Interfaces.DocumentUpdateData#removePersonalInformationOnSave:member + package: word! + fullName: removePersonalInformationOnSave + summary: Specifies whether Word removes user information upon saving. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removePersonalInformationOnSave?: boolean;' + return: + type: boolean + - name: saveEncoding + uid: word!Word.Interfaces.DocumentUpdateData#saveEncoding:member + package: word! + fullName: saveEncoding + summary: Specifies the encoding used when saving the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: textEncoding + uid: word!Word.Interfaces.DocumentUpdateData#textEncoding:member + package: word! + fullName: textEncoding + summary: Specifies the encoding for saving as encoded text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: textLineEnding + uid: word!Word.Interfaces.DocumentUpdateData#textLineEnding:member + package: word! + fullName: textLineEnding + summary: Specifies how Word marks line and paragraph breaks in text files. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | + "Lfcr" | "Lsps"; + return: + type: >- + | "Crlf" | "CrOnly" | + "LfOnly" | "Lfcr" | "Lsps" + - name: trackedChangesAreDateAndTimeRemoved + uid: >- + word!Word.Interfaces.DocumentUpdateData#trackedChangesAreDateAndTimeRemoved:member + package: word! + fullName: trackedChangesAreDateAndTimeRemoved + summary: >- + Specifies whether to remove or store date and time metadata for tracked + changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackedChangesAreDateAndTimeRemoved?: boolean;' + return: + type: boolean + - name: trackFormatting + uid: word!Word.Interfaces.DocumentUpdateData#trackFormatting:member + package: word! + fullName: trackFormatting + summary: Specifies whether to track formatting changes when change tracking is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackFormatting?: boolean;' + return: + type: boolean + - name: trackMoves + uid: word!Word.Interfaces.DocumentUpdateData#trackMoves:member + package: word! + fullName: trackMoves + summary: Specifies whether to mark moved text when Track Changes is on. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackMoves?: boolean;' + return: + type: boolean + - name: trackRevisions + uid: word!Word.Interfaces.DocumentUpdateData#trackRevisions:member + package: word! + fullName: trackRevisions + summary: Specifies whether changes are tracked in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'trackRevisions?: boolean;' + return: + type: boolean + - name: writePassword + uid: word!Word.Interfaces.DocumentUpdateData#writePassword:member + package: word! + fullName: writePassword + summary: Sets a password for saving changes to the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'writePassword?: string;' + return: + type: string + - name: xmlAreAdvancedErrorsShown + uid: word!Word.Interfaces.DocumentUpdateData#xmlAreAdvancedErrorsShown:member + package: word! + fullName: xmlAreAdvancedErrorsShown + summary: >- + Specifies whether error messages are generated from built-in Word messages + or MSXML (Microsoft XML). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlAreAdvancedErrorsShown?: boolean;' + return: + type: boolean + - name: xmlIsXsltUsedWhenSaving + uid: word!Word.Interfaces.DocumentUpdateData#xmlIsXsltUsedWhenSaving:member + package: word! + fullName: xmlIsXsltUsedWhenSaving + summary: >- + Specifies whether to save a document through an Extensible Stylesheet + Language Transformation (XSLT). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlIsXsltUsedWhenSaving?: boolean;' + return: + type: boolean + - name: xmlSaveThroughXSLT + uid: word!Word.Interfaces.DocumentUpdateData#xmlSaveThroughXSLT:member + package: word! + fullName: xmlSaveThroughXSLT + summary: >- + Specifies the path and file name for the XSLT to apply when saving a + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'xmlSaveThroughXSLT?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectiondata.yml new file mode 100644 index 0000000000..300d4410d1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionCollectionData +uid: word!Word.Interfaces.HtmlDivisionCollectionData:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionCollectionData +summary: >- + An interface describing the data returned by calling + `htmlDivisionCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.HtmlDivisionCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.HtmlDivisionData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionloadoptions.yml new file mode 100644 index 0000000000..561104487e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionloadoptions.yml @@ -0,0 +1,124 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionCollectionLoadOptions +uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionCollectionLoadOptions +summary: >- + Represents a collection of + [Word.HtmlDivision](xref:word!Word.HtmlDivision:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#$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: leftIndent + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#leftIndent:member + package: word! + fullName: leftIndent + summary: >- + For EACH ITEM in the collection: Specifies the left indent value (in + points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + portion of a document that's contained in this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: rightIndent + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#rightIndent:member + package: word! + fullName: rightIndent + summary: >- + For EACH ITEM in the collection: Specifies the right indent (in points) + for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightIndent?: boolean;' + return: + type: boolean + - name: spaceAfter + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#spaceAfter:member + package: word! + fullName: spaceAfter + summary: >- + For EACH ITEM in the collection: Specifies the amount of spacing (in + points) after this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceAfter?: boolean;' + return: + type: boolean + - name: spaceBefore + uid: word!Word.Interfaces.HtmlDivisionCollectionLoadOptions#spaceBefore:member + package: word! + fullName: spaceBefore + summary: >- + For EACH ITEM in the collection: Specifies the spacing (in points) before + this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceBefore?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionupdatedata.yml new file mode 100644 index 0000000000..0b82aad107 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisioncollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionCollectionUpdateData +uid: word!Word.Interfaces.HtmlDivisionCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionCollectionUpdateData +summary: >- + An interface for updating data on the `HtmlDivisionCollection` object, for use + in `htmlDivisionCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.HtmlDivisionCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.HtmlDivisionData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisiondata.yml new file mode 100644 index 0000000000..fe005b0da7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisiondata.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionData +uid: word!Word.Interfaces.HtmlDivisionData:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionData +summary: >- + An interface describing the data returned by calling + `htmlDivision.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: leftIndent + uid: word!Word.Interfaces.HtmlDivisionData#leftIndent:member + package: word! + fullName: leftIndent + summary: Specifies the left indent value (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: number;' + return: + type: number + - name: rightIndent + uid: word!Word.Interfaces.HtmlDivisionData#rightIndent:member + package: word! + fullName: rightIndent + summary: Specifies the right indent (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightIndent?: number;' + return: + type: number + - name: spaceAfter + uid: word!Word.Interfaces.HtmlDivisionData#spaceAfter:member + package: word! + fullName: spaceAfter + summary: Specifies the amount of spacing (in points) after this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceAfter?: number;' + return: + type: number + - name: spaceBefore + uid: word!Word.Interfaces.HtmlDivisionData#spaceBefore:member + package: word! + fullName: spaceBefore + summary: Specifies the spacing (in points) before this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceBefore?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionloadoptions.yml new file mode 100644 index 0000000000..9b3a79dce7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionloadoptions.yml @@ -0,0 +1,113 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionLoadOptions +uid: word!Word.Interfaces.HtmlDivisionLoadOptions:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionLoadOptions +summary: '' +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#$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: leftIndent + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#leftIndent:member + package: word! + fullName: leftIndent + summary: Specifies the left indent value (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of a document that's + contained in this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: rightIndent + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#rightIndent:member + package: word! + fullName: rightIndent + summary: Specifies the right indent (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightIndent?: boolean;' + return: + type: boolean + - name: spaceAfter + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#spaceAfter:member + package: word! + fullName: spaceAfter + summary: Specifies the amount of spacing (in points) after this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceAfter?: boolean;' + return: + type: boolean + - name: spaceBefore + uid: word!Word.Interfaces.HtmlDivisionLoadOptions#spaceBefore:member + package: word! + fullName: spaceBefore + summary: Specifies the spacing (in points) before this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceBefore?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionupdatedata.yml new file mode 100644 index 0000000000..4502212d5c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.htmldivisionupdatedata.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Word.Interfaces.HtmlDivisionUpdateData +uid: word!Word.Interfaces.HtmlDivisionUpdateData:interface +package: word! +fullName: Word.Interfaces.HtmlDivisionUpdateData +summary: >- + An interface for updating data on the `HtmlDivision` object, for use in + `htmlDivision.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: leftIndent + uid: word!Word.Interfaces.HtmlDivisionUpdateData#leftIndent:member + package: word! + fullName: leftIndent + summary: Specifies the left indent value (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: number;' + return: + type: number + - name: rightIndent + uid: word!Word.Interfaces.HtmlDivisionUpdateData#rightIndent:member + package: word! + fullName: rightIndent + summary: Specifies the right indent (in points) for this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightIndent?: number;' + return: + type: number + - name: spaceAfter + uid: word!Word.Interfaces.HtmlDivisionUpdateData#spaceAfter:member + package: word! + fullName: spaceAfter + summary: Specifies the amount of spacing (in points) after this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceAfter?: number;' + return: + type: number + - name: spaceBefore + uid: word!Word.Interfaces.HtmlDivisionUpdateData#spaceBefore:member + package: word! + fullName: spaceBefore + summary: Specifies the spacing (in points) before this HTML division. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spaceBefore?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.oleformatdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.oleformatdata.yml index b17be8d2c5..df3b1cfba4 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.oleformatdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.oleformatdata.yml @@ -138,10 +138,10 @@ properties: content: 'label?: string;' return: type: string - - name: progID - uid: word!Word.Interfaces.OleFormatData#progID:member + - name: progId + uid: word!Word.Interfaces.OleFormatData#progId:member package: word! - fullName: progID + fullName: progId summary: >- Gets the programmatic identifier (`ProgId`) for the specified OLE object. @@ -152,6 +152,6 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'progID?: string;' + content: 'progId?: string;' return: type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.oleformatloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.oleformatloadoptions.yml index 1ed2ebaa10..3f7c03488c 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.oleformatloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.oleformatloadoptions.yml @@ -157,10 +157,10 @@ properties: content: 'label?: boolean;' return: type: boolean - - name: progID - uid: word!Word.Interfaces.OleFormatLoadOptions#progID:member + - name: progId + uid: word!Word.Interfaces.OleFormatLoadOptions#progId:member package: word! - fullName: progID + fullName: progId summary: >- Gets the programmatic identifier (`ProgId`) for the specified OLE object. @@ -171,6 +171,6 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'progID?: boolean;' + content: 'progId?: boolean;' return: type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectiondata.yml new file mode 100644 index 0000000000..86d51b6174 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Word.Interfaces.ReadabilityStatisticCollectionData +uid: word!Word.Interfaces.ReadabilityStatisticCollectionData:interface +package: word! +fullName: Word.Interfaces.ReadabilityStatisticCollectionData +summary: >- + An interface describing the data returned by calling + `readabilityStatisticCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ReadabilityStatisticCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ReadabilityStatisticData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionloadoptions.yml new file mode 100644 index 0000000000..b932041cb3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionloadoptions.yml @@ -0,0 +1,68 @@ +### YamlMime:TSType +name: Word.Interfaces.ReadabilityStatisticCollectionLoadOptions +uid: word!Word.Interfaces.ReadabilityStatisticCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.ReadabilityStatisticCollectionLoadOptions +summary: >- + Represents a collection of + [Word.ReadabilityStatistic](xref:word!Word.ReadabilityStatistic:class) objects + for the document or range. +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.ReadabilityStatisticCollectionLoadOptions#$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: name + uid: word!Word.Interfaces.ReadabilityStatisticCollectionLoadOptions#name:member + package: word! + fullName: name + summary: >- + For EACH ITEM in the collection: Returns the name of the readability + statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: value + uid: >- + word!Word.Interfaces.ReadabilityStatisticCollectionLoadOptions#value:member + package: word! + fullName: value + summary: >- + For EACH ITEM in the collection: Returns the value of the grammar + statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionupdatedata.yml new file mode 100644 index 0000000000..670672d7cb --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticcollectionupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Word.Interfaces.ReadabilityStatisticCollectionUpdateData +uid: word!Word.Interfaces.ReadabilityStatisticCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.ReadabilityStatisticCollectionUpdateData +summary: >- + An interface for updating data on the `ReadabilityStatisticCollection` object, + for use in `readabilityStatisticCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ReadabilityStatisticCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ReadabilityStatisticData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticdata.yml new file mode 100644 index 0000000000..34465399a4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticdata.yml @@ -0,0 +1,44 @@ +### YamlMime:TSType +name: Word.Interfaces.ReadabilityStatisticData +uid: word!Word.Interfaces.ReadabilityStatisticData:interface +package: word! +fullName: Word.Interfaces.ReadabilityStatisticData +summary: >- + An interface describing the data returned by calling + `readabilityStatistic.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: word!Word.Interfaces.ReadabilityStatisticData#name:member + package: word! + fullName: name + summary: Returns the name of the readability statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: value + uid: word!Word.Interfaces.ReadabilityStatisticData#value:member + package: word! + fullName: value + summary: Returns the value of the grammar statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'value?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticloadoptions.yml new file mode 100644 index 0000000000..be1ee55f53 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.readabilitystatisticloadoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Word.Interfaces.ReadabilityStatisticLoadOptions +uid: word!Word.Interfaces.ReadabilityStatisticLoadOptions:interface +package: word! +fullName: Word.Interfaces.ReadabilityStatisticLoadOptions +summary: Represents one of the readability statistics for the document or range. +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.ReadabilityStatisticLoadOptions#$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: name + uid: word!Word.Interfaces.ReadabilityStatisticLoadOptions#name:member + package: word! + fullName: name + summary: Returns the name of the readability statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: value + uid: word!Word.Interfaces.ReadabilityStatisticLoadOptions#value:member + package: word! + fullName: value + summary: Returns the value of the grammar statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.websettingsdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsdata.yml new file mode 100644 index 0000000000..2209e15934 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsdata.yml @@ -0,0 +1,284 @@ +### YamlMime:TSType +name: Word.Interfaces.WebSettingsData +uid: word!Word.Interfaces.WebSettingsData:interface +package: word! +fullName: Word.Interfaces.WebSettingsData +summary: >- + An interface describing the data returned by calling + `webSettings.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowPng + uid: word!Word.Interfaces.WebSettingsData#allowPng:member + package: word! + fullName: allowPng + summary: >- + Specifies whether PNG is allowed as an image format when saving a document + as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'allowPng?: boolean;' + return: + type: boolean + - name: encoding + uid: word!Word.Interfaces.WebSettingsData#encoding:member + package: word! + fullName: encoding + summary: >- + Specifies the document encoding (code page or character set) to be used by + the web browser when viewing the saved document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: folderSuffix + uid: word!Word.Interfaces.WebSettingsData#folderSuffix:member + package: word! + fullName: folderSuffix + summary: >- + Gets the folder suffix used when saving a document as a webpage with long + file names and supporting files in a separate folder. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'folderSuffix?: string;' + return: + type: string + - name: organizeInFolder + uid: word!Word.Interfaces.WebSettingsData#organizeInFolder:member + package: word! + fullName: organizeInFolder + summary: >- + Specifies whether supporting files are organized in a separate folder when + saving the document as a webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'organizeInFolder?: boolean;' + return: + type: boolean + - name: pixelsPerInch + uid: word!Word.Interfaces.WebSettingsData#pixelsPerInch:member + package: word! + fullName: pixelsPerInch + summary: >- + Specifies the density (pixels per inch) of graphics images and table cells + on a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pixelsPerInch?: number;' + return: + type: number + - name: relyOnCSS + uid: word!Word.Interfaces.WebSettingsData#relyOnCSS:member + package: word! + fullName: relyOnCSS + summary: >- + Specifies whether cascading style sheets (CSS) are used for font + formatting when viewing a saved document in a web browser. Default is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnCSS?: boolean;' + return: + type: boolean + - name: relyOnVectorMarkupLanguage + uid: word!Word.Interfaces.WebSettingsData#relyOnVectorMarkupLanguage:member + package: word! + fullName: relyOnVectorMarkupLanguage + summary: >- + Specifies whether image files are not generated from drawing objects when + saving a document as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnVectorMarkupLanguage?: boolean;' + return: + type: boolean + - name: screenSize + uid: word!Word.Interfaces.WebSettingsData#screenSize:member + package: word! + fullName: screenSize + summary: >- + Specifies the ideal minimum screen size (width by height, in pixels) for + viewing the saved document in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | + "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | + "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | + "Size1920x1200"; + return: + type: >- + | "Size544x376" | + "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | + "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | + "Size1800x1440" | "Size1920x1200" + - name: targetBrowser + uid: word!Word.Interfaces.WebSettingsData#targetBrowser:member + package: word! + fullName: targetBrowser + summary: Specifies the target browser for documents viewed in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | + "Ie6"; + return: + type: >- + | "V3" | "V4" | "Ie4" | + "Ie5" | "Ie6" + - name: useLongFileNames + uid: word!Word.Interfaces.WebSettingsData#useLongFileNames:member + package: word! + fullName: useLongFileNames + summary: >- + Specifies whether long file names are used when saving the document as a + webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useLongFileNames?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.websettingsloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsloadoptions.yml new file mode 100644 index 0000000000..392ecb4c92 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsloadoptions.yml @@ -0,0 +1,200 @@ +### YamlMime:TSType +name: Word.Interfaces.WebSettingsLoadOptions +uid: word!Word.Interfaces.WebSettingsLoadOptions:interface +package: word! +fullName: Word.Interfaces.WebSettingsLoadOptions +summary: Represents the settings for saving a Word document as a webpage. +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.WebSettingsLoadOptions#$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: allowPng + uid: word!Word.Interfaces.WebSettingsLoadOptions#allowPng:member + package: word! + fullName: allowPng + summary: >- + Specifies whether PNG is allowed as an image format when saving a document + as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'allowPng?: boolean;' + return: + type: boolean + - name: encoding + uid: word!Word.Interfaces.WebSettingsLoadOptions#encoding:member + package: word! + fullName: encoding + summary: >- + Specifies the document encoding (code page or character set) to be used by + the web browser when viewing the saved document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'encoding?: boolean;' + return: + type: boolean + - name: folderSuffix + uid: word!Word.Interfaces.WebSettingsLoadOptions#folderSuffix:member + package: word! + fullName: folderSuffix + summary: >- + Gets the folder suffix used when saving a document as a webpage with long + file names and supporting files in a separate folder. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'folderSuffix?: boolean;' + return: + type: boolean + - name: organizeInFolder + uid: word!Word.Interfaces.WebSettingsLoadOptions#organizeInFolder:member + package: word! + fullName: organizeInFolder + summary: >- + Specifies whether supporting files are organized in a separate folder when + saving the document as a webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'organizeInFolder?: boolean;' + return: + type: boolean + - name: pixelsPerInch + uid: word!Word.Interfaces.WebSettingsLoadOptions#pixelsPerInch:member + package: word! + fullName: pixelsPerInch + summary: >- + Specifies the density (pixels per inch) of graphics images and table cells + on a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pixelsPerInch?: boolean;' + return: + type: boolean + - name: relyOnCSS + uid: word!Word.Interfaces.WebSettingsLoadOptions#relyOnCSS:member + package: word! + fullName: relyOnCSS + summary: >- + Specifies whether cascading style sheets (CSS) are used for font + formatting when viewing a saved document in a web browser. Default is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnCSS?: boolean;' + return: + type: boolean + - name: relyOnVectorMarkupLanguage + uid: >- + word!Word.Interfaces.WebSettingsLoadOptions#relyOnVectorMarkupLanguage:member + package: word! + fullName: relyOnVectorMarkupLanguage + summary: >- + Specifies whether image files are not generated from drawing objects when + saving a document as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnVectorMarkupLanguage?: boolean;' + return: + type: boolean + - name: screenSize + uid: word!Word.Interfaces.WebSettingsLoadOptions#screenSize:member + package: word! + fullName: screenSize + summary: >- + Specifies the ideal minimum screen size (width by height, in pixels) for + viewing the saved document in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'screenSize?: boolean;' + return: + type: boolean + - name: targetBrowser + uid: word!Word.Interfaces.WebSettingsLoadOptions#targetBrowser:member + package: word! + fullName: targetBrowser + summary: Specifies the target browser for documents viewed in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'targetBrowser?: boolean;' + return: + type: boolean + - name: useLongFileNames + uid: word!Word.Interfaces.WebSettingsLoadOptions#useLongFileNames:member + package: word! + fullName: useLongFileNames + summary: >- + Specifies whether long file names are used when saving the document as a + webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useLongFileNames?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.websettingsupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsupdatedata.yml new file mode 100644 index 0000000000..7b49fe3889 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.websettingsupdatedata.yml @@ -0,0 +1,268 @@ +### YamlMime:TSType +name: Word.Interfaces.WebSettingsUpdateData +uid: word!Word.Interfaces.WebSettingsUpdateData:interface +package: word! +fullName: Word.Interfaces.WebSettingsUpdateData +summary: >- + An interface for updating data on the `WebSettings` object, for use in + `webSettings.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: allowPng + uid: word!Word.Interfaces.WebSettingsUpdateData#allowPng:member + package: word! + fullName: allowPng + summary: >- + Specifies whether PNG is allowed as an image format when saving a document + as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'allowPng?: boolean;' + return: + type: boolean + - name: encoding + uid: word!Word.Interfaces.WebSettingsUpdateData#encoding:member + package: word! + fullName: encoding + summary: >- + Specifies the document encoding (code page or character set) to be used by + the web browser when viewing the saved document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: organizeInFolder + uid: word!Word.Interfaces.WebSettingsUpdateData#organizeInFolder:member + package: word! + fullName: organizeInFolder + summary: >- + Specifies whether supporting files are organized in a separate folder when + saving the document as a webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'organizeInFolder?: boolean;' + return: + type: boolean + - name: pixelsPerInch + uid: word!Word.Interfaces.WebSettingsUpdateData#pixelsPerInch:member + package: word! + fullName: pixelsPerInch + summary: >- + Specifies the density (pixels per inch) of graphics images and table cells + on a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pixelsPerInch?: number;' + return: + type: number + - name: relyOnCSS + uid: word!Word.Interfaces.WebSettingsUpdateData#relyOnCSS:member + package: word! + fullName: relyOnCSS + summary: >- + Specifies whether cascading style sheets (CSS) are used for font + formatting when viewing a saved document in a web browser. Default is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnCSS?: boolean;' + return: + type: boolean + - name: relyOnVectorMarkupLanguage + uid: >- + word!Word.Interfaces.WebSettingsUpdateData#relyOnVectorMarkupLanguage:member + package: word! + fullName: relyOnVectorMarkupLanguage + summary: >- + Specifies whether image files are not generated from drawing objects when + saving a document as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnVectorMarkupLanguage?: boolean;' + return: + type: boolean + - name: screenSize + uid: word!Word.Interfaces.WebSettingsUpdateData#screenSize:member + package: word! + fullName: screenSize + summary: >- + Specifies the ideal minimum screen size (width by height, in pixels) for + viewing the saved document in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | + "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | + "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | + "Size1920x1200"; + return: + type: >- + | "Size544x376" | + "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | + "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | + "Size1800x1440" | "Size1920x1200" + - name: targetBrowser + uid: word!Word.Interfaces.WebSettingsUpdateData#targetBrowser:member + package: word! + fullName: targetBrowser + summary: Specifies the target browser for documents viewed in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | + "Ie6"; + return: + type: >- + | "V3" | "V4" | "Ie4" | + "Ie5" | "Ie6" + - name: useLongFileNames + uid: word!Word.Interfaces.WebSettingsUpdateData#useLongFileNames:member + package: word! + fullName: useLongFileNames + summary: >- + Specifies whether long file names are used when saving the document as a + webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useLongFileNames?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectiondata.yml new file mode 100644 index 0000000000..6beb2eedd8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeCollectionData +uid: word!Word.Interfaces.XmlNodeCollectionData:interface +package: word! +fullName: Word.Interfaces.XmlNodeCollectionData +summary: >- + An interface describing the data returned by calling + `xmlNodeCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.XmlNodeCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.XmlNodeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionloadoptions.yml new file mode 100644 index 0000000000..71e3d972b7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionloadoptions.yml @@ -0,0 +1,328 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeCollectionLoadOptions +uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.XmlNodeCollectionLoadOptions +summary: >- + Represents the collection of [Word.XmlNode](xref:word!Word.XmlNode:class) + objects. +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.XmlNodeCollectionLoadOptions#$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: baseName + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#baseName:member + package: word! + fullName: baseName + summary: >- + For EACH ITEM in the collection: Gets the name of the element without any + prefix. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'baseName?: boolean;' + return: + type: boolean + - name: firstChild + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#firstChild:member + package: word! + fullName: firstChild + summary: >- + For EACH ITEM in the collection: Gets the first child node if this is a + parent node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'firstChild?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: hasChildNodes + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#hasChildNodes:member + package: word! + fullName: hasChildNodes + summary: >- + For EACH ITEM in the collection: Gets whether this XML node has child + nodes. Always returns `false` for attribute nodes since they cannot have + children. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasChildNodes?: boolean;' + return: + type: boolean + - name: lastChild + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#lastChild:member + package: word! + fullName: lastChild + summary: >- + For EACH ITEM in the collection: Gets the last child node if this is a + parent node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lastChild?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: level + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#level:member + package: word! + fullName: level + summary: >- + For EACH ITEM in the collection: Gets whether this XML element is part of + a paragraph, is a paragraph, or is contained within a table cell or + contains a table row. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: namespaceUri + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#namespaceUri:member + package: word! + fullName: namespaceUri + summary: >- + For EACH ITEM in the collection: Gets the Uniform Resource Identifier + (URI) of the schema namespace for this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'namespaceUri?: boolean;' + return: + type: boolean + - name: nextSibling + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#nextSibling:member + package: word! + fullName: nextSibling + summary: >- + For EACH ITEM in the collection: Gets the next element in the document + that's at the same level as this XML node. Returns `null` if the node type + is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextSibling?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: nodeType + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#nodeType:member + package: word! + fullName: nodeType + summary: 'For EACH ITEM in the collection: Gets the type of node.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeType?: boolean;' + return: + type: boolean + - name: nodeValue + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#nodeValue:member + package: word! + fullName: nodeValue + summary: >- + For EACH ITEM in the collection: Specifies the value of this XML node. For + element nodes, represents the text content; for attribute nodes, + represents the attribute value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeValue?: boolean;' + return: + type: boolean + - name: ownerDocument + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#ownerDocument:member + package: word! + fullName: ownerDocument + summary: >- + For EACH ITEM in the collection: Gets the parent document of this XML + node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ownerDocument?: Word.Interfaces.DocumentLoadOptions;' + return: + type: + - name: parentNode + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#parentNode:member + package: word! + fullName: parentNode + summary: 'For EACH ITEM in the collection: Gets the parent element of this XML node.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentNode?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: placeholderText + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#placeholderText:member + package: word! + fullName: placeholderText + summary: >- + For EACH ITEM in the collection: Specifies the text displayed for this + element if it contains no text. Only applies to element nodes, not + attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'placeholderText?: boolean;' + return: + type: boolean + - name: previousSibling + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#previousSibling:member + package: word! + fullName: previousSibling + summary: >- + For EACH ITEM in the collection: Gets the previous element in the document + that's at the same level as this XML node. Returns `null` if the node type + is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'previousSibling?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets the portion of a document that is + contained in this XML node. Returns `null` if the node type is + `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: text + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#text:member + package: word! + fullName: text + summary: >- + For EACH ITEM in the collection: Specifies the text contained within the + XML element. Returns an empty string if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: validationErrorText + uid: >- + word!Word.Interfaces.XmlNodeCollectionLoadOptions#validationErrorText:member + package: word! + fullName: validationErrorText + summary: >- + For EACH ITEM in the collection: Gets the description for a validation + error on this `XmlNode` object. May not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationErrorText?: boolean;' + return: + type: boolean + - name: validationStatus + uid: word!Word.Interfaces.XmlNodeCollectionLoadOptions#validationStatus:member + package: word! + fullName: validationStatus + summary: >- + For EACH ITEM in the collection: Gets whether this element is valid + according to the attached schema. May not be meaningful for attribute + nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationStatus?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionupdatedata.yml new file mode 100644 index 0000000000..24a27b62d9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeCollectionUpdateData +uid: word!Word.Interfaces.XmlNodeCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.XmlNodeCollectionUpdateData +summary: >- + An interface for updating data on the `XmlNodeCollection` object, for use in + `xmlNodeCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.XmlNodeCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.XmlNodeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodedata.yml new file mode 100644 index 0000000000..1372634c2e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodedata.yml @@ -0,0 +1,183 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeData +uid: word!Word.Interfaces.XmlNodeData:interface +package: word! +fullName: Word.Interfaces.XmlNodeData +summary: >- + An interface describing the data returned by calling `xmlNode.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: baseName + uid: word!Word.Interfaces.XmlNodeData#baseName:member + package: word! + fullName: baseName + summary: Gets the name of the element without any prefix. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'baseName?: string;' + return: + type: string + - name: hasChildNodes + uid: word!Word.Interfaces.XmlNodeData#hasChildNodes:member + package: word! + fullName: hasChildNodes + summary: >- + Gets whether this XML node has child nodes. Always returns `false` for + attribute nodes since they cannot have children. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasChildNodes?: boolean;' + return: + type: boolean + - name: level + uid: word!Word.Interfaces.XmlNodeData#level:member + package: word! + fullName: level + summary: >- + Gets whether this XML element is part of a paragraph, is a paragraph, or + is contained within a table cell or contains a table row. Returns `null` + if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";' + return: + type: >- + | "Inline" | "Paragraph" | + "Row" | "Cell" + - name: namespaceUri + uid: word!Word.Interfaces.XmlNodeData#namespaceUri:member + package: word! + fullName: namespaceUri + summary: >- + Gets the Uniform Resource Identifier (URI) of the schema namespace for + this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'namespaceUri?: string;' + return: + type: string + - name: nodeType + uid: word!Word.Interfaces.XmlNodeData#nodeType:member + package: word! + fullName: nodeType + summary: Gets the type of node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeType?: Word.XmlNodeType | "Element" | "Attribute";' + return: + type: | "Element" | "Attribute" + - name: nodeValue + uid: word!Word.Interfaces.XmlNodeData#nodeValue:member + package: word! + fullName: nodeValue + summary: >- + Specifies the value of this XML node. For element nodes, represents the + text content; for attribute nodes, represents the attribute value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeValue?: string;' + return: + type: string + - name: placeholderText + uid: word!Word.Interfaces.XmlNodeData#placeholderText:member + package: word! + fullName: placeholderText + summary: >- + Specifies the text displayed for this element if it contains no text. Only + applies to element nodes, not attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'placeholderText?: string;' + return: + type: string + - name: text + uid: word!Word.Interfaces.XmlNodeData#text:member + package: word! + fullName: text + summary: >- + Specifies the text contained within the XML element. Returns an empty + string if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: validationErrorText + uid: word!Word.Interfaces.XmlNodeData#validationErrorText:member + package: word! + fullName: validationErrorText + summary: >- + Gets the description for a validation error on this `XmlNode` object. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationErrorText?: string;' + return: + type: string + - name: validationStatus + uid: word!Word.Interfaces.XmlNodeData#validationStatus:member + package: word! + fullName: validationStatus + summary: >- + Gets whether this element is valid according to the attached schema. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom";' + return: + type: | "Ok" | "Custom" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeloadoptions.yml new file mode 100644 index 0000000000..597b4feb39 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeloadoptions.yml @@ -0,0 +1,312 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeLoadOptions +uid: word!Word.Interfaces.XmlNodeLoadOptions:interface +package: word! +fullName: Word.Interfaces.XmlNodeLoadOptions +summary: Represents a single XML node applied to the document. +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.XmlNodeLoadOptions#$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: baseName + uid: word!Word.Interfaces.XmlNodeLoadOptions#baseName:member + package: word! + fullName: baseName + summary: Gets the name of the element without any prefix. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'baseName?: boolean;' + return: + type: boolean + - name: firstChild + uid: word!Word.Interfaces.XmlNodeLoadOptions#firstChild:member + package: word! + fullName: firstChild + summary: >- + Gets the first child node if this is a parent node. Returns `null` if the + node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'firstChild?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: hasChildNodes + uid: word!Word.Interfaces.XmlNodeLoadOptions#hasChildNodes:member + package: word! + fullName: hasChildNodes + summary: >- + Gets whether this XML node has child nodes. Always returns `false` for + attribute nodes since they cannot have children. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasChildNodes?: boolean;' + return: + type: boolean + - name: lastChild + uid: word!Word.Interfaces.XmlNodeLoadOptions#lastChild:member + package: word! + fullName: lastChild + summary: >- + Gets the last child node if this is a parent node. Returns `null` if the + node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lastChild?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: level + uid: word!Word.Interfaces.XmlNodeLoadOptions#level:member + package: word! + fullName: level + summary: >- + Gets whether this XML element is part of a paragraph, is a paragraph, or + is contained within a table cell or contains a table row. Returns `null` + if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: namespaceUri + uid: word!Word.Interfaces.XmlNodeLoadOptions#namespaceUri:member + package: word! + fullName: namespaceUri + summary: >- + Gets the Uniform Resource Identifier (URI) of the schema namespace for + this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'namespaceUri?: boolean;' + return: + type: boolean + - name: nextSibling + uid: word!Word.Interfaces.XmlNodeLoadOptions#nextSibling:member + package: word! + fullName: nextSibling + summary: >- + Gets the next element in the document that's at the same level as this XML + node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextSibling?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: nodeType + uid: word!Word.Interfaces.XmlNodeLoadOptions#nodeType:member + package: word! + fullName: nodeType + summary: Gets the type of node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeType?: boolean;' + return: + type: boolean + - name: nodeValue + uid: word!Word.Interfaces.XmlNodeLoadOptions#nodeValue:member + package: word! + fullName: nodeValue + summary: >- + Specifies the value of this XML node. For element nodes, represents the + text content; for attribute nodes, represents the attribute value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeValue?: boolean;' + return: + type: boolean + - name: ownerDocument + uid: word!Word.Interfaces.XmlNodeLoadOptions#ownerDocument:member + package: word! + fullName: ownerDocument + summary: Gets the parent document of this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ownerDocument?: Word.Interfaces.DocumentLoadOptions;' + return: + type: + - name: parentNode + uid: word!Word.Interfaces.XmlNodeLoadOptions#parentNode:member + package: word! + fullName: parentNode + summary: Gets the parent element of this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentNode?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: placeholderText + uid: word!Word.Interfaces.XmlNodeLoadOptions#placeholderText:member + package: word! + fullName: placeholderText + summary: >- + Specifies the text displayed for this element if it contains no text. Only + applies to element nodes, not attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'placeholderText?: boolean;' + return: + type: boolean + - name: previousSibling + uid: word!Word.Interfaces.XmlNodeLoadOptions#previousSibling:member + package: word! + fullName: previousSibling + summary: >- + Gets the previous element in the document that's at the same level as this + XML node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'previousSibling?: Word.Interfaces.XmlNodeLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.XmlNodeLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets the portion of a document that is contained in this XML node. Returns + `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: text + uid: word!Word.Interfaces.XmlNodeLoadOptions#text:member + package: word! + fullName: text + summary: >- + Specifies the text contained within the XML element. Returns an empty + string if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: validationErrorText + uid: word!Word.Interfaces.XmlNodeLoadOptions#validationErrorText:member + package: word! + fullName: validationErrorText + summary: >- + Gets the description for a validation error on this `XmlNode` object. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationErrorText?: boolean;' + return: + type: boolean + - name: validationStatus + uid: word!Word.Interfaces.XmlNodeLoadOptions#validationStatus:member + package: word! + fullName: validationStatus + summary: >- + Gets whether this element is valid according to the attached schema. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validationStatus?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeupdatedata.yml new file mode 100644 index 0000000000..1b9f798f82 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.xmlnodeupdatedata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Word.Interfaces.XmlNodeUpdateData +uid: word!Word.Interfaces.XmlNodeUpdateData:interface +package: word! +fullName: Word.Interfaces.XmlNodeUpdateData +summary: >- + An interface for updating data on the `XmlNode` object, for use in + `xmlNode.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: nodeValue + uid: word!Word.Interfaces.XmlNodeUpdateData#nodeValue:member + package: word! + fullName: nodeValue + summary: >- + Specifies the value of this XML node. For element nodes, represents the + text content; for attribute nodes, represents the attribute value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeValue?: string;' + return: + type: string + - name: placeholderText + uid: word!Word.Interfaces.XmlNodeUpdateData#placeholderText:member + package: word! + fullName: placeholderText + summary: >- + Specifies the text displayed for this element if it contains no text. Only + applies to element nodes, not attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'placeholderText?: string;' + return: + type: string + - name: text + uid: word!Word.Interfaces.XmlNodeUpdateData#text:member + package: word! + fullName: text + summary: >- + Specifies the text contained within the XML element. Returns an empty + string if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.lineendingtype.yml b/docs/docs-ref-autogen/word/word/word.lineendingtype.yml new file mode 100644 index 0000000000..ca396357b0 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.lineendingtype.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Word.LineEndingType +uid: word!Word.LineEndingType:enum +package: word! +fullName: Word.LineEndingType +summary: Represents how Word marks line and paragraph breaks in text files. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: crlf + uid: word!Word.LineEndingType.crlf:member + package: word! + summary: >- + Represents carriage return and line feed (Windows standard). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Crlf"' + - name: crOnly + uid: word!Word.LineEndingType.crOnly:member + package: word! + summary: >- + Represents carriage return only (Mac classic standard). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CrOnly"' + - name: lfcr + uid: word!Word.LineEndingType.lfcr:member + package: word! + summary: >- + Represents line feed and carriage return. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Lfcr"' + - name: lfOnly + uid: word!Word.LineEndingType.lfOnly:member + package: word! + summary: >- + Represents line feed only (Unix/Linux standard). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LfOnly"' + - name: lsps + uid: word!Word.LineEndingType.lsps:member + package: word! + summary: >- + Represents line separator and paragraph separator. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Lsps"' diff --git a/docs/docs-ref-autogen/word/word/word.mergetarget.yml b/docs/docs-ref-autogen/word/word/word.mergetarget.yml new file mode 100644 index 0000000000..ed89a14231 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.mergetarget.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.MergeTarget +uid: word!Word.MergeTarget:enum +package: word! +fullName: Word.MergeTarget +summary: Specifies the target document for merge operations. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: current + uid: word!Word.MergeTarget.current:member + package: word! + summary: >- + Represents merging into the current document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Current"' + - name: new + uid: word!Word.MergeTarget.new:member + package: word! + summary: >- + Represents merging into a new document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"New"' + - name: selected + uid: word!Word.MergeTarget.selected:member + package: word! + summary: >- + Represents merging into the selected document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Selected"' diff --git a/docs/docs-ref-autogen/word/word/word.oleformat.yml b/docs/docs-ref-autogen/word/word/word.oleformat.yml index cf5fa8f44a..3f42b141c5 100644 --- a/docs/docs-ref-autogen/word/word/word.oleformat.yml +++ b/docs/docs-ref-autogen/word/word/word.oleformat.yml @@ -155,10 +155,10 @@ properties: content: 'readonly label: string;' return: type: string - - name: progID - uid: word!Word.OleFormat#progID:member + - name: progId + uid: word!Word.OleFormat#progId:member package: word! - fullName: progID + fullName: progId summary: >- Gets the programmatic identifier (`ProgId`) for the specified OLE object. @@ -169,7 +169,7 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'readonly progID: string;' + content: 'readonly progId: string;' return: type: string methods: diff --git a/docs/docs-ref-autogen/word/word/word.printoutitem.yml b/docs/docs-ref-autogen/word/word/word.printoutitem.yml new file mode 100644 index 0000000000..40f70e7a50 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.printoutitem.yml @@ -0,0 +1,103 @@ +### YamlMime:TSEnum +name: Word.PrintOutItem +uid: word!Word.PrintOutItem:enum +package: word! +fullName: Word.PrintOutItem +summary: Specifies the type of item to print from a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: autoTextEntries + uid: word!Word.PrintOutItem.autoTextEntries:member + package: word! + summary: >- + Represents printing the AutoText entries. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AutoTextEntries"' + - name: comments + uid: word!Word.PrintOutItem.comments:member + package: word! + summary: >- + Represents printing the comments. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Comments"' + - name: documentContent + uid: word!Word.PrintOutItem.documentContent:member + package: word! + summary: >- + Represents printing the document content. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentContent"' + - name: documentWithMarkup + uid: word!Word.PrintOutItem.documentWithMarkup:member + package: word! + summary: >- + Represents printing the document with markup. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentWithMarkup"' + - name: envelope + uid: word!Word.PrintOutItem.envelope:member + package: word! + summary: >- + Represents printing the envelope. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Envelope"' + - name: keyAssignments + uid: word!Word.PrintOutItem.keyAssignments:member + package: word! + summary: >- + Represents printing the key assignments. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KeyAssignments"' + - name: markup + uid: word!Word.PrintOutItem.markup:member + package: word! + summary: >- + Represents printing the markup. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Markup"' + - name: properties + uid: word!Word.PrintOutItem.properties:member + package: word! + summary: >- + Represents printing the document properties. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Properties"' + - name: styles + uid: word!Word.PrintOutItem.styles:member + package: word! + summary: >- + Represents printing the styles. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Styles"' diff --git a/docs/docs-ref-autogen/word/word/word.printoutpages.yml b/docs/docs-ref-autogen/word/word/word.printoutpages.yml new file mode 100644 index 0000000000..58f3ed9738 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.printoutpages.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.PrintOutPages +uid: word!Word.PrintOutPages:enum +package: word! +fullName: Word.PrintOutPages +summary: Specifies which pages to print based on odd or even page numbers. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: all + uid: word!Word.PrintOutPages.all:member + package: word! + summary: >- + Represents printing all pages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"All"' + - name: evenOnly + uid: word!Word.PrintOutPages.evenOnly:member + package: word! + summary: >- + Represents printing only even-numbered pages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EvenOnly"' + - name: oddOnly + uid: word!Word.PrintOutPages.oddOnly:member + package: word! + summary: >- + Represents printing only odd-numbered pages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OddOnly"' diff --git a/docs/docs-ref-autogen/word/word/word.printoutrange.yml b/docs/docs-ref-autogen/word/word/word.printoutrange.yml new file mode 100644 index 0000000000..71a946c5b9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.printoutrange.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Word.PrintOutRange +uid: word!Word.PrintOutRange:enum +package: word! +fullName: Word.PrintOutRange +summary: Specifies the range of content to print from a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: allDocument + uid: word!Word.PrintOutRange.allDocument:member + package: word! + summary: >- + Represents printing the entire document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AllDocument"' + - name: currentPage + uid: word!Word.PrintOutRange.currentPage:member + package: word! + summary: >- + Represents printing the current page. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CurrentPage"' + - name: fromTo + uid: word!Word.PrintOutRange.fromTo:member + package: word! + summary: >- + Represents printing a range from one page to another. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FromTo"' + - name: rangeOfPages + uid: word!Word.PrintOutRange.rangeOfPages:member + package: word! + summary: >- + Represents printing specific ranges of pages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"RangeOfPages"' + - name: selection + uid: word!Word.PrintOutRange.selection:member + package: word! + summary: >- + Represents printing the current selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Selection"' diff --git a/docs/docs-ref-autogen/word/word/word.protectiontype.yml b/docs/docs-ref-autogen/word/word/word.protectiontype.yml new file mode 100644 index 0000000000..7cff5e3d5e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.protectiontype.yml @@ -0,0 +1,64 @@ +### YamlMime:TSEnum +name: Word.ProtectionType +uid: word!Word.ProtectionType:enum +package: word! +fullName: Word.ProtectionType +summary: Specifies the protection type for a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: allowOnlyComments + uid: word!Word.ProtectionType.allowOnlyComments:member + package: word! + summary: >- + Only comments are allowed in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AllowOnlyComments"' + - name: allowOnlyFormFields + uid: word!Word.ProtectionType.allowOnlyFormFields:member + package: word! + summary: >- + Only form fields are allowed in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AllowOnlyFormFields"' + - name: allowOnlyReading + uid: word!Word.ProtectionType.allowOnlyReading:member + package: word! + summary: >- + Only reading is allowed in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AllowOnlyReading"' + - name: allowOnlyRevisions + uid: word!Word.ProtectionType.allowOnlyRevisions:member + package: word! + summary: >- + Only revisions are allowed in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + value: '"AllowOnlyRevisions"' + - name: noProtection + uid: word!Word.ProtectionType.noProtection:member + package: word! + summary: >- + No protection is applied to the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NoProtection"' diff --git a/docs/docs-ref-autogen/word/word/word.readabilitystatistic.yml b/docs/docs-ref-autogen/word/word/word.readabilitystatistic.yml new file mode 100644 index 0000000000..850a8740b0 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.readabilitystatistic.yml @@ -0,0 +1,206 @@ +### YamlMime:TSType +name: Word.ReadabilityStatistic +uid: word!Word.ReadabilityStatistic:class +package: word! +fullName: Word.ReadabilityStatistic +summary: Represents one of the readability statistics for the document or range. +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.ReadabilityStatistic#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: name + uid: word!Word.ReadabilityStatistic#name:member + package: word! + fullName: name + summary: Returns the name of the readability statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: value + uid: word!Word.ReadabilityStatistic#value:member + package: word! + fullName: value + summary: Returns the value of the grammar statistic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly value: number;' + return: + type: number +methods: + - name: load(options) + uid: word!Word.ReadabilityStatistic#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.ReadabilityStatisticLoadOptions): + Word.ReadabilityStatistic; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ReadabilityStatistic#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.ReadabilityStatistic;' + 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.ReadabilityStatistic#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.ReadabilityStatistic; + 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: toJSON() + uid: word!Word.ReadabilityStatistic#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.ReadabilityStatistic` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.ReadabilityStatisticData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ReadabilityStatisticData;' + return: + type: + description: '' + - name: track() + uid: word!Word.ReadabilityStatistic#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.ReadabilityStatistic;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ReadabilityStatistic#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.ReadabilityStatistic;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.readabilitystatisticcollection.yml b/docs/docs-ref-autogen/word/word/word.readabilitystatisticcollection.yml new file mode 100644 index 0000000000..a51336a397 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.readabilitystatisticcollection.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: Word.ReadabilityStatisticCollection +uid: word!Word.ReadabilityStatisticCollection:class +package: word! +fullName: Word.ReadabilityStatisticCollection +summary: >- + Represents a collection of + [Word.ReadabilityStatistic](xref:word!Word.ReadabilityStatistic:class) objects + for the document or range. +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.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection#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.ReadabilityStatistic[];' + return: + type: [] +methods: + - name: getItemAt(index) + uid: word!Word.ReadabilityStatisticCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: Gets the readability statistic at the specified index. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Word.ReadabilityStatistic;' + parameters: + - id: index + description: The zero-based index of the readability statistic to get. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.ReadabilityStatisticCollection#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.ReadabilityStatisticCollectionLoadOptions + & Word.Interfaces.CollectionLoadOptions): + Word.ReadabilityStatisticCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection; + 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.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection; + 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.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Word.Interfaces.ReadabilityStatisticCollectionData`) 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.ReadabilityStatisticCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ReadabilityStatisticCollection#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.ReadabilityStatisticCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.removedocinfotype.yml b/docs/docs-ref-autogen/word/word/word.removedocinfotype.yml new file mode 100644 index 0000000000..9917e18ecc --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.removedocinfotype.yml @@ -0,0 +1,214 @@ +### YamlMime:TSEnum +name: Word.RemoveDocInfoType +uid: word!Word.RemoveDocInfoType:enum +package: word! +fullName: Word.RemoveDocInfoType +summary: Specifies the type of document information to remove. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: all + uid: word!Word.RemoveDocInfoType.all:member + package: word! + summary: >- + All document information types. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"All"' + - name: atMentions + uid: word!Word.RemoveDocInfoType.atMentions:member + package: word! + summary: >- + At mentions in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AtMentions"' + - name: commentReactions + uid: word!Word.RemoveDocInfoType.commentReactions:member + package: word! + summary: >- + Comment reactions in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CommentReactions"' + - name: comments + uid: word!Word.RemoveDocInfoType.comments:member + package: word! + summary: >- + Comments in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Comments"' + - name: contentType + uid: word!Word.RemoveDocInfoType.contentType:member + package: word! + summary: >- + Content type information. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ContentType"' + - name: documentIntelligence + uid: word!Word.RemoveDocInfoType.documentIntelligence:member + package: word! + summary: >- + Document intelligence information. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentIntelligence"' + - name: documentManagementPolicy + uid: word!Word.RemoveDocInfoType.documentManagementPolicy:member + package: word! + summary: >- + Document management policy. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentManagementPolicy"' + - name: documentProperties + uid: word!Word.RemoveDocInfoType.documentProperties:member + package: word! + summary: >- + Document properties. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentProperties"' + - name: documentServerProperties + uid: word!Word.RemoveDocInfoType.documentServerProperties:member + package: word! + summary: >- + Document server properties. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentServerProperties"' + - name: documentTasks + uid: word!Word.RemoveDocInfoType.documentTasks:member + package: word! + summary: >- + Document tasks. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentTasks"' + - name: documentWorkspace + uid: word!Word.RemoveDocInfoType.documentWorkspace:member + package: word! + summary: >- + Document workspace properties. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DocumentWorkspace"' + - name: emailHeader + uid: word!Word.RemoveDocInfoType.emailHeader:member + package: word! + summary: >- + Email header in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EmailHeader"' + - name: inkAnnotations + uid: word!Word.RemoveDocInfoType.inkAnnotations:member + package: word! + summary: >- + Ink annotations in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"InkAnnotations"' + - name: removePersonalInformation + uid: word!Word.RemoveDocInfoType.removePersonalInformation:member + package: word! + summary: >- + Personal information in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"RemovePersonalInformation"' + - name: revisions + uid: word!Word.RemoveDocInfoType.revisions:member + package: word! + summary: >- + Revisions in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + value: '"Revisions"' + - name: routingSlip + uid: word!Word.RemoveDocInfoType.routingSlip:member + package: word! + summary: >- + Routing slip in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"RoutingSlip"' + - name: sendForReview + uid: word!Word.RemoveDocInfoType.sendForReview:member + package: word! + summary: >- + Send for review information in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SendForReview"' + - name: taskpaneWebExtensions + uid: word!Word.RemoveDocInfoType.taskpaneWebExtensions:member + package: word! + summary: >- + Taskpane web extensions. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TaskpaneWebExtensions"' + - name: template + uid: word!Word.RemoveDocInfoType.template:member + package: word! + summary: >- + Template information. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Template"' + - name: versions + uid: word!Word.RemoveDocInfoType.versions:member + package: word! + summary: >- + Versions in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Versions"' diff --git a/docs/docs-ref-autogen/word/word/word.screensize.yml b/docs/docs-ref-autogen/word/word/word.screensize.yml new file mode 100644 index 0000000000..ee8b90d354 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.screensize.yml @@ -0,0 +1,123 @@ +### YamlMime:TSEnum +name: Word.ScreenSize +uid: word!Word.ScreenSize:enum +package: word! +fullName: Word.ScreenSize +summary: Specifies the screen size for web page preview and HTML export optimization. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: size1024x768 + uid: word!Word.ScreenSize.size1024x768:member + package: word! + summary: >- + Screen resolution 1024x768 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1024x768"' + - name: size1152x882 + uid: word!Word.ScreenSize.size1152x882:member + package: word! + summary: >- + Screen resolution 1152x882 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1152x882"' + - name: size1152x900 + uid: word!Word.ScreenSize.size1152x900:member + package: word! + summary: >- + Screen resolution 1152x900 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1152x900"' + - name: size1280x1024 + uid: word!Word.ScreenSize.size1280x1024:member + package: word! + summary: >- + Screen resolution 1280x1024 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1280x1024"' + - name: size1600x1200 + uid: word!Word.ScreenSize.size1600x1200:member + package: word! + summary: >- + Screen resolution 1600x1200 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1600x1200"' + - name: size1800x1440 + uid: word!Word.ScreenSize.size1800x1440:member + package: word! + summary: >- + Screen resolution 1800x1440 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1800x1440"' + - name: size1920x1200 + uid: word!Word.ScreenSize.size1920x1200:member + package: word! + summary: >- + Screen resolution 1920x1200 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size1920x1200"' + - name: size544x376 + uid: word!Word.ScreenSize.size544x376:member + package: word! + summary: >- + Screen resolution 544x376 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size544x376"' + - name: size640x480 + uid: word!Word.ScreenSize.size640x480:member + package: word! + summary: >- + Screen resolution 640x480 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size640x480"' + - name: size720x512 + uid: word!Word.ScreenSize.size720x512:member + package: word! + summary: >- + Screen resolution 720x512 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size720x512"' + - name: size800x600 + uid: word!Word.ScreenSize.size800x600:member + package: word! + summary: >- + Screen resolution 800x600 pixels. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Size800x600"' diff --git a/docs/docs-ref-autogen/word/word/word.selectnodesoptions.yml b/docs/docs-ref-autogen/word/word/word.selectnodesoptions.yml new file mode 100644 index 0000000000..14aaa5e414 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectnodesoptions.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Word.SelectNodesOptions +uid: word!Word.SelectNodesOptions:interface +package: word! +fullName: Word.SelectNodesOptions +summary: >- + Provides configuration options for the + [XmlNode.selectNodes](xref:word!Word.XmlNode:class) and + [Document.selectNodes](xref:word!Word.Document:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: fastSearchSkippingTextNodes + uid: word!Word.SelectNodesOptions#fastSearchSkippingTextNodes:member + package: word! + fullName: fastSearchSkippingTextNodes + summary: >- + If provided, specifies whether to skip text nodes in the search. The + default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fastSearchSkippingTextNodes?: boolean;' + return: + type: boolean + - name: prefixMapping + uid: word!Word.SelectNodesOptions#prefixMapping:member + package: word! + fullName: prefixMapping + summary: >- + If provided, specifies the prefix mapping for the XPath expression. The + default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'prefixMapping?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.selectsinglenodeoptions.yml b/docs/docs-ref-autogen/word/word/word.selectsinglenodeoptions.yml new file mode 100644 index 0000000000..0e7c0d1e92 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectsinglenodeoptions.yml @@ -0,0 +1,51 @@ +### YamlMime:TSType +name: Word.SelectSingleNodeOptions +uid: word!Word.SelectSingleNodeOptions:interface +package: word! +fullName: Word.SelectSingleNodeOptions +summary: >- + Provides configuration options for the + [XmlNode.selectSingleNode](xref:word!Word.XmlNode:class) and + [Document.selectSingleNode](xref:word!Word.Document:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: fastSearchSkippingTextNodes + uid: word!Word.SelectSingleNodeOptions#fastSearchSkippingTextNodes:member + package: word! + fullName: fastSearchSkippingTextNodes + summary: >- + If provided, specifies whether to skip text nodes in the search. The + default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fastSearchSkippingTextNodes?: boolean;' + return: + type: boolean + - name: prefixMapping + uid: word!Word.SelectSingleNodeOptions#prefixMapping:member + package: word! + fullName: prefixMapping + summary: >- + If provided, specifies the prefix mapping for the XPath expression. The + default value is "" (empty string). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'prefixMapping?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.statistic.yml b/docs/docs-ref-autogen/word/word/word.statistic.yml new file mode 100644 index 0000000000..0a2e5cf371 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.statistic.yml @@ -0,0 +1,83 @@ +### YamlMime:TSEnum +name: Word.Statistic +uid: word!Word.Statistic:enum +package: word! +fullName: Word.Statistic +summary: Document statistic types. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: characters + uid: word!Word.Statistic.characters:member + package: word! + summary: >- + Characters in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Characters"' + - name: charactersWithSpaces + uid: word!Word.Statistic.charactersWithSpaces:member + package: word! + summary: >- + Characters including spaces. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CharactersWithSpaces"' + - name: farEastCharacters + uid: word!Word.Statistic.farEastCharacters:member + package: word! + summary: >- + Far East (DBCS) characters. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FarEastCharacters"' + - name: lines + uid: word!Word.Statistic.lines:member + package: word! + summary: >- + Lines in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Lines"' + - name: pages + uid: word!Word.Statistic.pages:member + package: word! + summary: >- + Pages in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Pages"' + - name: paragraphs + uid: word!Word.Statistic.paragraphs:member + package: word! + summary: >- + Paragraphs in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Paragraphs"' + - name: words + uid: word!Word.Statistic.words:member + package: word! + summary: >- + Words in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Words"' diff --git a/docs/docs-ref-autogen/word/word/word.targetbrowser.yml b/docs/docs-ref-autogen/word/word/word.targetbrowser.yml new file mode 100644 index 0000000000..ae22256e0f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.targetbrowser.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Word.TargetBrowser +uid: word!Word.TargetBrowser:enum +package: word! +fullName: Word.TargetBrowser +summary: Specifies the target web browser for HTML export and web page optimization. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: ie4 + uid: word!Word.TargetBrowser.ie4:member + package: word! + summary: >- + Microsoft Internet Explorer 4. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ie4"' + - name: ie5 + uid: word!Word.TargetBrowser.ie5:member + package: word! + summary: >- + Microsoft Internet Explorer 5. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ie5"' + - name: ie6 + uid: word!Word.TargetBrowser.ie6:member + package: word! + summary: >- + Microsoft Internet Explorer 6. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ie6"' + - name: v3 + uid: word!Word.TargetBrowser.v3:member + package: word! + summary: >- + Browser version 3. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"V3"' + - name: v4 + uid: word!Word.TargetBrowser.v4:member + package: word! + summary: >- + Browser version 4. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"V4"' diff --git a/docs/docs-ref-autogen/word/word/word.textcolumncollection.yml b/docs/docs-ref-autogen/word/word/word.textcolumncollection.yml index dce6f50b28..429e770003 100644 --- a/docs/docs-ref-autogen/word/word/word.textcolumncollection.yml +++ b/docs/docs-ref-autogen/word/word/word.textcolumncollection.yml @@ -124,28 +124,6 @@ methods: <boolean> description: '' - - name: getItem(index) - uid: word!Word.TextColumnCollection#getItem:member(1) - package: word! - fullName: getItem(index) - summary: Gets a `TextColumn` by its index in the collection. - remarks: >- - \[ [API set: WordApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - isPreview: true - isDeprecated: false - syntax: - content: 'getItem(index: number): Word.TextColumn;' - parameters: - - id: index - description: >- - A number that identifies the index location of a `TextColumn` - object. - type: number - return: - type: - description: '' - name: load(options) uid: word!Word.TextColumnCollection#load:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.useformattingfrom.yml b/docs/docs-ref-autogen/word/word/word.useformattingfrom.yml new file mode 100644 index 0000000000..1bbfb93e1f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.useformattingfrom.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.UseFormattingFrom +uid: word!Word.UseFormattingFrom:enum +package: word! +fullName: Word.UseFormattingFrom +summary: Specifies the source of formatting to use during document operations. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: current + uid: word!Word.UseFormattingFrom.current:member + package: word! + summary: >- + Represents using formatting from the current document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Current"' + - name: prompt + uid: word!Word.UseFormattingFrom.prompt:member + package: word! + summary: >- + Represents prompting the user for formatting preferences. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Prompt"' + - name: selected + uid: word!Word.UseFormattingFrom.selected:member + package: word! + summary: >- + Represents using formatting from the selected document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Selected"' diff --git a/docs/docs-ref-autogen/word/word/word.websettings.yml b/docs/docs-ref-autogen/word/word/word.websettings.yml new file mode 100644 index 0000000000..df4e4e04fe --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.websettings.yml @@ -0,0 +1,458 @@ +### YamlMime:TSType +name: Word.WebSettings +uid: word!Word.WebSettings:class +package: word! +fullName: Word.WebSettings +summary: Represents the settings for saving a Word document as a webpage. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: allowPng + uid: word!Word.WebSettings#allowPng:member + package: word! + fullName: allowPng + summary: >- + Specifies whether PNG is allowed as an image format when saving a document + as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'allowPng: boolean;' + return: + type: boolean + - name: context + uid: word!Word.WebSettings#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: encoding + uid: word!Word.WebSettings#encoding:member + package: word! + fullName: encoding + summary: >- + Specifies the document encoding (code page or character set) to be used by + the web browser when viewing the saved document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | + "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | + "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | + "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | + "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | + "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | + "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | + "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | + "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | + "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | + "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | + "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | + "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | + "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | + "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | + "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | + "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" + | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | + "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | + "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | + "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | + "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | + "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | + "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | + "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | + "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | + "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | + "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + return: + type: >- + | "Thai" | + "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | + "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" + | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | + "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | + "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | + "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | + "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | + "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | + "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | + "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | + "Iso885915Latin9" | "Iso88598HebrewLogical" | + "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | + "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" + | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | + "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" + | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | + "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | + "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" + | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | + "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | + "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | + "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | + "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | + "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | + "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | + "EbcdicJapaneseKatakanaExtendedAndJapanese" | + "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | + "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | + "EbcdicUsCanadaAndTraditionalChinese" | + "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | + "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | + "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | + "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | + "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | + "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | + "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" + | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | + "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | + "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | + "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | + "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" + | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | + "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | + "SimplifiedChineseGb18030" | "Utf7" | "Utf8" + - name: folderSuffix + uid: word!Word.WebSettings#folderSuffix:member + package: word! + fullName: folderSuffix + summary: >- + Gets the folder suffix used when saving a document as a webpage with long + file names and supporting files in a separate folder. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly folderSuffix: string;' + return: + type: string + - name: organizeInFolder + uid: word!Word.WebSettings#organizeInFolder:member + package: word! + fullName: organizeInFolder + summary: >- + Specifies whether supporting files are organized in a separate folder when + saving the document as a webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'organizeInFolder: boolean;' + return: + type: boolean + - name: pixelsPerInch + uid: word!Word.WebSettings#pixelsPerInch:member + package: word! + fullName: pixelsPerInch + summary: >- + Specifies the density (pixels per inch) of graphics images and table cells + on a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pixelsPerInch: number;' + return: + type: number + - name: relyOnCSS + uid: word!Word.WebSettings#relyOnCSS:member + package: word! + fullName: relyOnCSS + summary: >- + Specifies whether cascading style sheets (CSS) are used for font + formatting when viewing a saved document in a web browser. Default is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnCSS: boolean;' + return: + type: boolean + - name: relyOnVectorMarkupLanguage + uid: word!Word.WebSettings#relyOnVectorMarkupLanguage:member + package: word! + fullName: relyOnVectorMarkupLanguage + summary: >- + Specifies whether image files are not generated from drawing objects when + saving a document as a webpage. Default is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'relyOnVectorMarkupLanguage: boolean;' + return: + type: boolean + - name: screenSize + uid: word!Word.WebSettings#screenSize:member + package: word! + fullName: screenSize + summary: >- + Specifies the ideal minimum screen size (width by height, in pixels) for + viewing the saved document in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | + "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | + "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | + "Size1920x1200"; + return: + type: >- + | "Size544x376" | + "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | + "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | + "Size1800x1440" | "Size1920x1200" + - name: targetBrowser + uid: word!Word.WebSettings#targetBrowser:member + package: word! + fullName: targetBrowser + summary: Specifies the target browser for documents viewed in a web browser. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6";' + return: + type: >- + | "V3" | "V4" | "Ie4" | + "Ie5" | "Ie6" + - name: useLongFileNames + uid: word!Word.WebSettings#useLongFileNames:member + package: word! + fullName: useLongFileNames + summary: >- + Specifies whether long file names are used when saving the document as a + webpage. Default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useLongFileNames: boolean;' + return: + type: boolean +methods: + - name: load(options) + uid: word!Word.WebSettings#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.WebSettingsLoadOptions): + Word.WebSettings; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.WebSettings#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.WebSettings;' + 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.WebSettings#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.WebSettings; + 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: toJSON() + uid: word!Word.WebSettings#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.WebSettings` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.WebSettingsData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.WebSettingsData;' + return: + type: + description: '' + - name: track() + uid: word!Word.WebSettings#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.WebSettings;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.WebSettings#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.WebSettings;' + return: + type: + description: '' + - name: useDefaultFolderSuffix() + uid: word!Word.WebSettings#useDefaultFolderSuffix:member(1) + package: word! + fullName: useDefaultFolderSuffix() + summary: >- + Sets the folder suffix for the specified document to the default suffix + for the language support you have selected or installed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useDefaultFolderSuffix(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.xmlnode.yml b/docs/docs-ref-autogen/word/word/word.xmlnode.yml new file mode 100644 index 0000000000..3ed82ea128 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlnode.yml @@ -0,0 +1,702 @@ +### YamlMime:TSType +name: Word.XmlNode +uid: word!Word.XmlNode:class +package: word! +fullName: Word.XmlNode +summary: Represents a single XML node applied to the document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: attributes + uid: word!Word.XmlNode#attributes:member + package: word! + fullName: attributes + summary: >- + Gets the attributes for this XML node. Returns `null` if the node type is + `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly attributes: Word.XmlNodeCollection;' + return: + type: + - name: baseName + uid: word!Word.XmlNode#baseName:member + package: word! + fullName: baseName + summary: Gets the name of the element without any prefix. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly baseName: string;' + return: + type: string + - name: childNodes + uid: word!Word.XmlNode#childNodes:member + package: word! + fullName: childNodes + summary: >- + Gets the child elements of this XML node. Returns an empty collection if + the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly childNodes: Word.XmlNodeCollection;' + return: + type: + - name: context + uid: word!Word.XmlNode#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: firstChild + uid: word!Word.XmlNode#firstChild:member + package: word! + fullName: firstChild + summary: >- + Gets the first child node if this is a parent node. Returns `null` if the + node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly firstChild: Word.XmlNode;' + return: + type: + - name: hasChildNodes + uid: word!Word.XmlNode#hasChildNodes:member + package: word! + fullName: hasChildNodes + summary: >- + Gets whether this XML node has child nodes. Always returns `false` for + attribute nodes since they cannot have children. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly hasChildNodes: boolean;' + return: + type: boolean + - name: lastChild + uid: word!Word.XmlNode#lastChild:member + package: word! + fullName: lastChild + summary: >- + Gets the last child node if this is a parent node. Returns `null` if the + node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly lastChild: Word.XmlNode;' + return: + type: + - name: level + uid: word!Word.XmlNode#level:member + package: word! + fullName: level + summary: >- + Gets whether this XML element is part of a paragraph, is a paragraph, or + is contained within a table cell or contains a table row. Returns `null` + if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | + "Cell"; + return: + type: >- + | "Inline" | "Paragraph" | + "Row" | "Cell" + - name: namespaceUri + uid: word!Word.XmlNode#namespaceUri:member + package: word! + fullName: namespaceUri + summary: >- + Gets the Uniform Resource Identifier (URI) of the schema namespace for + this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly namespaceUri: string;' + return: + type: string + - name: nextSibling + uid: word!Word.XmlNode#nextSibling:member + package: word! + fullName: nextSibling + summary: >- + Gets the next element in the document that's at the same level as this XML + node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly nextSibling: Word.XmlNode;' + return: + type: + - name: nodeType + uid: word!Word.XmlNode#nodeType:member + package: word! + fullName: nodeType + summary: Gets the type of node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly nodeType: Word.XmlNodeType | "Element" | "Attribute";' + return: + type: | "Element" | "Attribute" + - name: nodeValue + uid: word!Word.XmlNode#nodeValue:member + package: word! + fullName: nodeValue + summary: >- + Specifies the value of this XML node. For element nodes, represents the + text content; for attribute nodes, represents the attribute value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nodeValue: string;' + return: + type: string + - name: ownerDocument + uid: word!Word.XmlNode#ownerDocument:member + package: word! + fullName: ownerDocument + summary: Gets the parent document of this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly ownerDocument: Word.Document;' + return: + type: + - name: parentNode + uid: word!Word.XmlNode#parentNode:member + package: word! + fullName: parentNode + summary: Gets the parent element of this XML node. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly parentNode: Word.XmlNode;' + return: + type: + - name: placeholderText + uid: word!Word.XmlNode#placeholderText:member + package: word! + fullName: placeholderText + summary: >- + Specifies the text displayed for this element if it contains no text. Only + applies to element nodes, not attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'placeholderText: string;' + return: + type: string + - name: previousSibling + uid: word!Word.XmlNode#previousSibling:member + package: word! + fullName: previousSibling + summary: >- + Gets the previous element in the document that's at the same level as this + XML node. Returns `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly previousSibling: Word.XmlNode;' + return: + type: + - name: range + uid: word!Word.XmlNode#range:member + package: word! + fullName: range + summary: >- + Gets the portion of a document that is contained in this XML node. Returns + `null` if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: text + uid: word!Word.XmlNode#text:member + package: word! + fullName: text + summary: >- + Specifies the text contained within the XML element. Returns an empty + string if the node type is `attribute`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: validationErrorText + uid: word!Word.XmlNode#validationErrorText:member + package: word! + fullName: validationErrorText + summary: >- + Gets the description for a validation error on this `XmlNode` object. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly validationErrorText: string;' + return: + type: string + - name: validationStatus + uid: word!Word.XmlNode#validationStatus:member + package: word! + fullName: validationStatus + summary: >- + Gets whether this element is valid according to the attached schema. May + not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";' + return: + type: | "Ok" | "Custom" +methods: + - name: copy() + uid: word!Word.XmlNode#copy:member(1) + package: word! + fullName: copy() + summary: >- + Copies this XML node, excluding XML markup, to the Clipboard. For + attribute nodes, copies only the attribute value as text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copy(): void;' + return: + type: void + description: '' + - name: cut() + uid: word!Word.XmlNode#cut:member(1) + package: word! + fullName: cut() + summary: >- + Removes this XML node from the document and places it on the Clipboard. + For attribute nodes, removes the attribute from its parent element and + copies only the attribute value as text to the clipboard. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'cut(): void;' + return: + type: void + description: '' + - name: delete() + uid: word!Word.XmlNode#delete:member(1) + package: word! + fullName: delete() + summary: >- + Deletes the XML node from the XML document. For element nodes, removes the + entire element and its content; for attribute nodes, removes the attribute + from its parent element. + 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.XmlNode#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.XmlNodeLoadOptions): Word.XmlNode;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.XmlNode#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.XmlNode;' + 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.XmlNode#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.XmlNode; + 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: removeChild(childElement) + uid: word!Word.XmlNode#removeChild:member(1) + package: word! + fullName: removeChild(childElement) + summary: >- + Removes a child element from this XML node. This method has no effect if + the node type is `attribute` (since attribute nodes have no child + elements). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removeChild(childElement: Word.XmlNode): void;' + parameters: + - id: childElement + description: The child element to remove. + type: + return: + type: void + description: '' + - name: selectNodes(xPath, options) + uid: word!Word.XmlNode#selectNodes:member(1) + package: word! + fullName: selectNodes(xPath, options) + summary: >- + Returns all the child elements that match the XPath parameter, in the + order in which they appear within this XML node. Returns `null` if the + node type is `attribute` (since attribute nodes have no child elements to + search). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectNodes(xPath: string, options?: Word.SelectNodesOptions): + Word.XmlNodeCollection; + parameters: + - id: xPath + description: The XPath expression to evaluate. + type: string + - id: options + description: Optional. Configuration options for the XPath search. + type: + return: + type: + description: A collection of XML nodes that match the XPath expression. + - name: selectSingleNode(xPath, options) + uid: word!Word.XmlNode#selectSingleNode:member(1) + package: word! + fullName: selectSingleNode(xPath, options) + summary: >- + Returns the first child element that matches the XPath parameter within + this XML node. Returns `null` if the node type is `attribute` (since + attribute nodes have no child elements to search). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): + Word.XmlNode; + parameters: + - id: xPath + description: The XPath expression to evaluate. + type: string + - id: options + description: Optional. Configuration options for the XPath search. + type: + return: + type: + description: >- + The first XML node that matches the XPath expression, or `null` if no + match is found. + - name: setValidationError(status, options) + uid: word!Word.XmlNode#setValidationError:member(1) + package: word! + fullName: setValidationError(status, options) + summary: >- + Changes the validation error text displayed to a user for this XML node + and whether to force Word to report the node as invalid. May not be + meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setValidationError(status: Word.XmlValidationStatus, options?: + Word.XmlNodeSetValidationErrorOptions): void; + parameters: + - id: status + description: The validation status to set. + type: + - id: options + description: Optional. Configuration options for setting the validation error. + type: + return: + type: void + description: '' + - name: setValidationError(status, options) + uid: word!Word.XmlNode#setValidationError:member(2) + package: word! + fullName: setValidationError(status, options) + summary: >- + Changes the validation error text displayed to a user for this XML node + and whether to force Word to report the node as invalid. May not be + meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setValidationError(status: "Ok" | "Custom", options?: + Word.XmlNodeSetValidationErrorOptions): void; + parameters: + - id: status + description: The validation status to set. + type: '"Ok" | "Custom"' + - id: options + description: Optional. Configuration options for setting the validation error. + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.XmlNode#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.XmlNode` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.XmlNodeData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.XmlNodeData;' + return: + type: + description: '' + - name: track() + uid: word!Word.XmlNode#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.XmlNode;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.XmlNode#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.XmlNode;' + return: + type: + description: '' + - name: validate() + uid: word!Word.XmlNode#validate:member(1) + package: word! + fullName: validate() + summary: >- + Validates this XML node against the XML schemas that are attached to the + document. May not be meaningful for attribute nodes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'validate(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.xmlnodecollection.yml b/docs/docs-ref-autogen/word/word/word.xmlnodecollection.yml new file mode 100644 index 0000000000..5a2819deae --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlnodecollection.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Word.XmlNodeCollection +uid: word!Word.XmlNodeCollection:class +package: word! +fullName: Word.XmlNodeCollection +summary: >- + Represents the collection of [Word.XmlNode](xref:word!Word.XmlNode:class) + objects. +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.XmlNodeCollection#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.XmlNodeCollection#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.XmlNode[];' + return: + type: [] +methods: + - name: getItem(index) + uid: word!Word.XmlNodeCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `XmlNode` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.XmlNode;' + parameters: + - id: index + description: A number that identifies the index location of a `XmlNode` object. + type: number + return: + type: + description: '' + - name: getItemAt(index) + uid: word!Word.XmlNodeCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: Returns an individual `XmlNode` object in a collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Word.XmlNode;' + parameters: + - id: index + description: The index of the XML node to retrieve. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.XmlNodeCollection#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.XmlNodeCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.XmlNodeCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.XmlNodeCollection#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.XmlNodeCollection;' + 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.XmlNodeCollection#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.XmlNodeCollection; + 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.XmlNodeCollection#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.XmlNodeCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.XmlNodeCollectionData`) 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.XmlNodeCollectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.XmlNodeCollection#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.XmlNodeCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.XmlNodeCollection#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.XmlNodeCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.xmlnodelevel.yml b/docs/docs-ref-autogen/word/word/word.xmlnodelevel.yml new file mode 100644 index 0000000000..6d7df0210d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlnodelevel.yml @@ -0,0 +1,53 @@ +### YamlMime:TSEnum +name: Word.XmlNodeLevel +uid: word!Word.XmlNodeLevel:enum +package: word! +fullName: Word.XmlNodeLevel +summary: Specifies the level of an XML node. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: cell + uid: word!Word.XmlNodeLevel.cell:member + package: word! + summary: >- + Cell node level. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Cell"' + - name: inline + uid: word!Word.XmlNodeLevel.inline:member + package: word! + summary: >- + Inline node level. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Inline"' + - name: paragraph + uid: word!Word.XmlNodeLevel.paragraph:member + package: word! + summary: >- + Paragraph node level. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Paragraph"' + - name: row + uid: word!Word.XmlNodeLevel.row:member + package: word! + summary: >- + Row node level. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Row"' diff --git a/docs/docs-ref-autogen/word/word/word.xmlnodesetvalidationerroroptions.yml b/docs/docs-ref-autogen/word/word/word.xmlnodesetvalidationerroroptions.yml new file mode 100644 index 0000000000..0da87141f9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlnodesetvalidationerroroptions.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Word.XmlNodeSetValidationErrorOptions +uid: word!Word.XmlNodeSetValidationErrorOptions:interface +package: word! +fullName: Word.XmlNodeSetValidationErrorOptions +summary: >- + Provides configuration options for the + [XmlNode.setValidationError](xref:word!Word.XmlNode:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: clearedAutomatically + uid: word!Word.XmlNodeSetValidationErrorOptions#clearedAutomatically:member + package: word! + fullName: clearedAutomatically + summary: >- + If provided, specifies whether the validation error should be cleared + automatically. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearedAutomatically?: boolean;' + return: + type: boolean + - name: errorText + uid: word!Word.XmlNodeSetValidationErrorOptions#errorText:member + package: word! + fullName: errorText + summary: If provided, specifies the error text to display for the validation error. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'errorText?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.xmlnodetype.yml b/docs/docs-ref-autogen/word/word/word.xmlnodetype.yml new file mode 100644 index 0000000000..d02207e02f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlnodetype.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.XmlNodeType +uid: word!Word.XmlNodeType:enum +package: word! +fullName: Word.XmlNodeType +summary: Specifies the type of an XML node. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: attribute + uid: word!Word.XmlNodeType.attribute:member + package: word! + summary: >- + Attribute node. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Attribute"' + - name: element + uid: word!Word.XmlNodeType.element:member + package: word! + summary: >- + Element node. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Element"' diff --git a/docs/docs-ref-autogen/word/word/word.xmlvalidationstatus.yml b/docs/docs-ref-autogen/word/word/word.xmlvalidationstatus.yml new file mode 100644 index 0000000000..d858b491d9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.xmlvalidationstatus.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.XmlValidationStatus +uid: word!Word.XmlValidationStatus:enum +package: word! +fullName: Word.XmlValidationStatus +summary: Specifies the validation status of an XML node. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: custom + uid: word!Word.XmlValidationStatus.custom:member + package: word! + summary: >- + The node has a custom (user-defined) validation error. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Custom"' + - name: ok + uid: word!Word.XmlValidationStatus.ok:member + package: word! + summary: >- + The node is valid. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ok"' diff --git a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml index 280e88a343..c7e5663976 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml @@ -159,6 +159,8 @@ items: uid: word!Word.Canvas:class - name: CheckboxContentControl uid: word!Word.CheckboxContentControl:class + - name: ComboBoxContentControl + uid: word!Word.ComboBoxContentControl:class - name: Comment uid: word!Word.Comment:class - name: CommentCollection @@ -183,6 +185,10 @@ items: uid: word!Word.ContentControlEnteredEventArgs:interface - name: ContentControlExitedEventArgs uid: word!Word.ContentControlExitedEventArgs:interface + - name: ContentControlListItem + uid: word!Word.ContentControlListItem:class + - name: ContentControlListItemCollection + uid: word!Word.ContentControlListItemCollection:class - name: ContentControlOptions uid: word!Word.ContentControlOptions:interface - name: ContentControlSelectionChangedEventArgs @@ -211,6 +217,8 @@ items: uid: word!Word.DocumentCreated:class - name: DocumentProperties uid: word!Word.DocumentProperties:class + - name: DropDownListContentControl + uid: word!Word.DropDownListContentControl:class - name: Field uid: word!Word.Field:class - name: FieldCollection diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word.yml b/docs/docs-ref-autogen/word_desktop_1_2/word.yml index d658cce91c..8bc2838c74 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word.yml @@ -69,6 +69,7 @@ classes: - word!Word.BorderCollection:class - word!Word.Canvas:class - word!Word.CheckboxContentControl:class + - word!Word.ComboBoxContentControl:class - word!Word.Comment:class - word!Word.CommentCollection:class - word!Word.CommentContentRange:class @@ -76,6 +77,8 @@ classes: - word!Word.CommentReplyCollection:class - word!Word.ContentControl:class - word!Word.ContentControlCollection:class + - word!Word.ContentControlListItem:class + - word!Word.ContentControlListItemCollection:class - word!Word.CritiqueAnnotation:class - word!Word.CustomProperty:class - word!Word.CustomPropertyCollection:class @@ -85,6 +88,7 @@ classes: - word!Word.Document:class - word!Word.DocumentCreated:class - word!Word.DocumentProperties:class + - word!Word.DropDownListContentControl:class - word!Word.Field:class - word!Word.FieldCollection:class - word!Word.Font:class @@ -196,8 +200,10 @@ interfaces: - word!Word.Interfaces.ContentControlCollectionUpdateData:interface - word!Word.Interfaces.ContentControlData:interface - word!Word.Interfaces.ContentControlListItemCollectionData:interface + - word!Word.Interfaces.ContentControlListItemCollectionLoadOptions:interface - word!Word.Interfaces.ContentControlListItemCollectionUpdateData:interface - word!Word.Interfaces.ContentControlListItemData:interface + - word!Word.Interfaces.ContentControlListItemLoadOptions:interface - word!Word.Interfaces.ContentControlListItemUpdateData:interface - word!Word.Interfaces.ContentControlLoadOptions:interface - word!Word.Interfaces.ContentControlUpdateData:interface diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.comboboxcontentcontrol.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.comboboxcontentcontrol.yml new file mode 100644 index 0000000000..8006936bef --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.comboboxcontentcontrol.yml @@ -0,0 +1,387 @@ +### YamlMime:TSType +name: Word.ComboBoxContentControl +uid: word!Word.ComboBoxContentControl:class +package: word! +fullName: Word.ComboBoxContentControl +summary: The data specific to content controls of type 'ComboBox'. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Places a combo box content control at the end of the selection. + + await Word.run(async (context) => { + let selection = context.document.getSelection(); + selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.comboBox); + await context.sync(); + + console.log("Combo box content control inserted at the end of the selection."); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ComboBoxContentControl#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: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: listItems + uid: word!Word.ComboBoxContentControl#listItems:member + package: word! + fullName: listItems + summary: Gets the collection of list items in the combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Deletes the provided list item from the first combo box content control + in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-delete") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedComboBox: Word.ComboBoxContentControl = selectedContentControl.comboBoxContentControl; + selectedComboBox.listItems.load("items/*"); + await context.sync(); + + let listItems: Word.ContentControlListItemCollection = selectedContentControl.comboBoxContentControl.listItems; + let itemToDelete: Word.ContentControlListItem = listItems.items.find((item) => item.displayText === listItemText); + if (!itemToDelete) { + console.warn(`List item doesn't exist in control with ID ${selectedContentControl.id}: ${listItemText}`); + return; + } + + itemToDelete.delete(); + await context.sync(); + + console.log(`List item deleted from control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listItems: Word.ContentControlListItemCollection;' + return: + type: +methods: + - name: addListItem(displayText, value, index) + uid: word!Word.ComboBoxContentControl#addListItem:member(1) + package: word! + fullName: addListItem(displayText, value, index) + summary: >- + Adds a new list item to this combo box content control and returns a + [Word.ContentControlListItem](xref:word!Word.ContentControlListItem:class) + object. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Adds the provided list item to the first combo box content control in + the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + selectedContentControl.comboBoxContentControl.addListItem(listItemText); + await context.sync(); + + console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + addListItem(displayText: string, value?: string, index?: number): + Word.ContentControlListItem; + parameters: + - id: displayText + description: Required. Display text of the list item. + type: string + - id: value + description: Optional. Value of the list item. + type: string + - id: index + description: >- + Optional. Index location of the new item in the list. If an item + exists at the position specified, the existing item is pushed down + in the list. If omitted, the new item is added to the end of the + list. + type: number + return: + type: + description: '' + - name: deleteAllListItems() + uid: word!Word.ComboBoxContentControl#deleteAllListItems:member(1) + package: word! + fullName: deleteAllListItems() + summary: Deletes all list items in this combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Deletes the list items from first combo box content control found in + the selection. + + await Word.run(async (context) => { + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + console.log(`About to delete the list from the combo box content control with ID ${selectedContentControl.id}`); + selectedContentControl.comboBoxContentControl.deleteAllListItems(); + await context.sync(); + + console.log("Deleted the list from the combo box content control."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteAllListItems(): void;' + return: + type: void + description: '' + - name: load(propertyNames) + uid: word!Word.ComboBoxContentControl#load:member(1) + 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: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ComboBoxContentControl;' + 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.ComboBoxContentControl#load:member(2) + 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: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ComboBoxContentControl; + 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: toJSON() + uid: word!Word.ComboBoxContentControl#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.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. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ComboBoxContentControlData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ComboBoxContentControl#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: false + isDeprecated: false + syntax: + content: 'track(): Word.ComboBoxContentControl;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ComboBoxContentControl#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: false + isDeprecated: false + syntax: + content: 'untrack(): Word.ComboBoxContentControl;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrol.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrol.yml index 482df4f900..a7f2e6041b 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrol.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrol.yml @@ -221,6 +221,68 @@ properties: content: 'color: string;' return: type: string + - name: comboBoxContentControl + uid: word!Word.ContentControl#comboBoxContentControl:member + package: word! + fullName: comboBoxContentControl + summary: >- + Gets the data of the content control when its type is `ComboBox`. + It's `null` otherwise. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Adds the provided list item to the first combo box content control in + the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + selectedContentControl.comboBoxContentControl.addListItem(listItemText); + await context.sync(); + + console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly comboBoxContentControl: Word.ComboBoxContentControl;' + return: + type: - name: contentControls uid: word!Word.ContentControl#contentControls:member package: word! @@ -251,6 +313,68 @@ properties: content: 'context: RequestContext;' return: type: + - name: dropDownListContentControl + uid: word!Word.ContentControl#dropDownListContentControl:member + package: word! + fullName: dropDownListContentControl + summary: >- + Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Adds the provided list item to the first dropdown list content control + in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + selectedContentControl.dropDownListContentControl.addListItem(listItemText); + await context.sync(); + + console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly dropDownListContentControl: Word.DropDownListContentControl;' + return: + type: - name: endnotes uid: word!Word.ContentControl#endnotes:member package: word! diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitem.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitem.yml new file mode 100644 index 0000000000..ac35bf9eb8 --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitem.yml @@ -0,0 +1,485 @@ +### YamlMime:TSType +name: Word.ContentControlListItem +uid: word!Word.ContentControlListItem:class +package: word! +fullName: Word.ContentControlListItem +summary: Represents a list item in a dropdown list or combo box content control. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Deletes the provided list item from the first dropdown list content control + in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-delete") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedDropdownList: Word.DropDownListContentControl = selectedContentControl.dropDownListContentControl; + selectedDropdownList.listItems.load("items/*"); + await context.sync(); + + let listItems: Word.ContentControlListItemCollection = selectedContentControl.dropDownListContentControl.listItems; + let itemToDelete: Word.ContentControlListItem = listItems.items.find((item) => item.displayText === listItemText); + if (!itemToDelete) { + console.warn(`List item doesn't exist in control with ID ${selectedContentControl.id}: ${listItemText}`) + return; + } + + itemToDelete.delete(); + await context.sync(); + + console.log(`List item deleted from control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: displayText + uid: word!Word.ContentControlListItem#displayText:member + package: word! + fullName: displayText + summary: >- + Specifies the display text of a list item for a dropdown list or combo box + content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Deletes the provided list item from the first dropdown list content + control in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-delete") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedDropdownList: Word.DropDownListContentControl = selectedContentControl.dropDownListContentControl; + selectedDropdownList.listItems.load("items/*"); + await context.sync(); + + let listItems: Word.ContentControlListItemCollection = selectedContentControl.dropDownListContentControl.listItems; + let itemToDelete: Word.ContentControlListItem = listItems.items.find((item) => item.displayText === listItemText); + if (!itemToDelete) { + console.warn(`List item doesn't exist in control with ID ${selectedContentControl.id}: ${listItemText}`) + return; + } + + itemToDelete.delete(); + await context.sync(); + + console.log(`List item deleted from control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'displayText: string;' + return: + type: string + - name: index + uid: word!Word.ContentControlListItem#index:member + package: word! + fullName: index + summary: >- + Specifies the index location of a content control list item in the + collection of list items. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index: number;' + return: + type: number + - name: value + uid: word!Word.ContentControlListItem#value:member + package: word! + fullName: value + summary: >- + Specifies the programmatic value of a list item for a dropdown list or + combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value: string;' + return: + type: string +methods: + - name: delete() + uid: word!Word.ContentControlListItem#delete:member(1) + package: word! + fullName: delete() + summary: Deletes the list item. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Deletes the provided list item from the first combo box content control + in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-delete") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedComboBox: Word.ComboBoxContentControl = selectedContentControl.comboBoxContentControl; + selectedComboBox.listItems.load("items/*"); + await context.sync(); + + let listItems: Word.ContentControlListItemCollection = selectedContentControl.comboBoxContentControl.listItems; + let itemToDelete: Word.ContentControlListItem = listItems.items.find((item) => item.displayText === listItemText); + if (!itemToDelete) { + console.warn(`List item doesn't exist in control with ID ${selectedContentControl.id}: ${listItemText}`); + return; + } + + itemToDelete.delete(); + await context.sync(); + + console.log(`List item deleted from control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.ContentControlListItemLoadOptions): + Word.ContentControlListItem; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ContentControlListItem;' + 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.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ContentControlListItem; + 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() + uid: word!Word.ContentControlListItem#select:member(1) + package: word! + fullName: select() + summary: >- + Selects the list item and sets the text of the content control to the + value of the list item. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ContentControlListItemUpdateData, 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.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: 'set(properties: Word.ContentControlListItem): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.ContentControlListItem#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.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. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ContentControlListItemData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: 'track(): Word.ContentControlListItem;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ContentControlListItem#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: false + isDeprecated: false + syntax: + content: 'untrack(): Word.ContentControlListItem;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitemcollection.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitemcollection.yml new file mode 100644 index 0000000000..fc100ec4fc --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.contentcontrollistitemcollection.yml @@ -0,0 +1,282 @@ +### YamlMime:TSType +name: Word.ContentControlListItemCollection +uid: word!Word.ContentControlListItemCollection:class +package: word! +fullName: Word.ContentControlListItemCollection +summary: >- + Contains a collection of + [Word.ContentControlListItem](xref:word!Word.ContentControlListItem:class) + objects that represent the items in a dropdown list or combo box content + control. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-combo-box-content-control.yaml + + + // Gets the list items from the first combo box content control found in the + selection. + + await Word.run(async (context) => { + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.comboBox] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,comboBoxContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,comboBoxContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.comboBox) { + console.warn("No combo box content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedComboBox: Word.ComboBoxContentControl = selectedContentControl.comboBoxContentControl; + selectedComboBox.listItems.load("items"); + await context.sync(); + + const currentItems: Word.ContentControlListItemCollection = selectedComboBox.listItems; + console.log(`The list from the combo box content control with ID ${selectedContentControl.id}:`, currentItems); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.ContentControlListItemCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly items: Word.ContentControlListItem[];' + return: + type: [] +methods: + - name: getFirst() + uid: word!Word.ContentControlListItemCollection#getFirst:member(1) + package: word! + fullName: getFirst() + summary: >- + Gets the first list item in this collection. Throws an `ItemNotFound` + error if this collection is empty. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirst(): Word.ContentControlListItem;' + return: + type: + description: '' + - name: getFirstOrNullObject() + uid: word!Word.ContentControlListItemCollection#getFirstOrNullObject:member(1) + package: word! + fullName: getFirstOrNullObject() + summary: >- + Gets the first list item 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 + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'getFirstOrNullObject(): Word.ContentControlListItem;' + return: + type: + description: '' + - name: load(options) + uid: word!Word.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: >- + load(options?: + Word.Interfaces.ContentControlListItemCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): + Word.ContentControlListItemCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.ContentControlListItemCollection; + 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.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.ContentControlListItemCollection; + 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.ContentControlListItemCollection#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.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. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ContentControlListItemCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: 'track(): Word.ContentControlListItemCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ContentControlListItemCollection#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: false + isDeprecated: false + syntax: + content: 'untrack(): Word.ContentControlListItemCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.dropdownlistcontentcontrol.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.dropdownlistcontentcontrol.yml new file mode 100644 index 0000000000..fdf8d5526f --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.dropdownlistcontentcontrol.yml @@ -0,0 +1,391 @@ +### YamlMime:TSType +name: Word.DropDownListContentControl +uid: word!Word.DropDownListContentControl:class +package: word! +fullName: Word.DropDownListContentControl +summary: The data specific to content controls of type DropDownList. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Places a dropdown list content control at the end of the selection. + + await Word.run(async (context) => { + let selection = context.document.getSelection(); + selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList); + await context.sync(); + + console.log("Dropdown list content control inserted at the end of the selection."); + }); + + ``` + +isPreview: false +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.DropDownListContentControl#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: false + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: listItems + uid: word!Word.DropDownListContentControl#listItems:member + package: word! + fullName: listItems + summary: Gets the collection of list items in the dropdown list content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Deletes the provided list item from the first dropdown list content + control in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-delete") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + let selectedDropdownList: Word.DropDownListContentControl = selectedContentControl.dropDownListContentControl; + selectedDropdownList.listItems.load("items/*"); + await context.sync(); + + let listItems: Word.ContentControlListItemCollection = selectedContentControl.dropDownListContentControl.listItems; + let itemToDelete: Word.ContentControlListItem = listItems.items.find((item) => item.displayText === listItemText); + if (!itemToDelete) { + console.warn(`List item doesn't exist in control with ID ${selectedContentControl.id}: ${listItemText}`) + return; + } + + itemToDelete.delete(); + await context.sync(); + + console.log(`List item deleted from control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'readonly listItems: Word.ContentControlListItemCollection;' + return: + type: +methods: + - name: addListItem(displayText, value, index) + uid: word!Word.DropDownListContentControl#addListItem:member(1) + package: word! + fullName: addListItem(displayText, value, index) + summary: >- + Adds a new list item to this dropdown list content control and returns a + [Word.ContentControlListItem](xref:word!Word.ContentControlListItem:class) + object. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Adds the provided list item to the first dropdown list content control + in the selection. + + await Word.run(async (context) => { + const listItemText = (document.getElementById("item-to-add") as HTMLInputElement).value.trim(); + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + selectedContentControl.dropDownListContentControl.addListItem(listItemText); + await context.sync(); + + console.log(`List item added to control with ID ${selectedContentControl.id}: ${listItemText}`); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: >- + addListItem(displayText: string, value?: string, index?: number): + Word.ContentControlListItem; + parameters: + - id: displayText + description: Required. Display text of the list item. + type: string + - id: value + description: Optional. Value of the list item. + type: string + - id: index + description: >- + Optional. Index location of the new item in the list. If an item + exists at the position specified, the existing item is pushed down + in the list. If omitted, the new item is added to the end of the + list. + type: number + return: + type: + description: '' + - name: deleteAllListItems() + uid: word!Word.DropDownListContentControl#deleteAllListItems:member(1) + package: word! + fullName: deleteAllListItems() + summary: Deletes all list items in this dropdown list content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-dropdown-list-content-control.yaml + + + // Deletes the list items from first dropdown list content control found + in the selection. + + await Word.run(async (context) => { + const selectedRange: Word.Range = context.document.getSelection(); + let selectedContentControl = selectedRange + .getContentControls({ + types: [Word.ContentControlType.dropDownList] + }) + .getFirstOrNullObject(); + selectedContentControl.load("id,dropDownListContentControl"); + await context.sync(); + + if (selectedContentControl.isNullObject) { + const parentContentControl: Word.ContentControl = selectedRange.parentContentControl; + parentContentControl.load("id,type,dropDownListContentControl"); + await context.sync(); + + if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.dropDownList) { + console.warn("No dropdown list content control is currently selected."); + return; + } else { + selectedContentControl = parentContentControl; + } + } + + console.log( + `About to delete the list from the dropdown list content control with ID ${selectedContentControl.id}` + ); + selectedContentControl.dropDownListContentControl.deleteAllListItems(); + await context.sync(); + + console.log("Deleted the list from the dropdown list content control."); + }); + + ``` + + isPreview: false + isDeprecated: false + syntax: + content: 'deleteAllListItems(): void;' + return: + type: void + description: '' + - name: load(propertyNames) + uid: word!Word.DropDownListContentControl#load:member(1) + 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: false + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.DropDownListContentControl; + 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.DropDownListContentControl#load:member(2) + 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: false + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropDownListContentControl; + 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: toJSON() + uid: word!Word.DropDownListContentControl#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.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. + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.DropDownListContentControlData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.DropDownListContentControl#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: false + isDeprecated: false + syntax: + content: 'track(): Word.DropDownListContentControl;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.DropDownListContentControl#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: false + isDeprecated: false + syntax: + content: 'untrack(): Word.DropDownListContentControl;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontroldata.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontroldata.yml index 6ec90e510f..045c1b7f1f 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontroldata.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontroldata.yml @@ -103,6 +103,25 @@ properties: content: 'color?: string;' return: type: string + - name: comboBoxContentControl + uid: word!Word.Interfaces.ContentControlData#comboBoxContentControl:member + package: word! + fullName: comboBoxContentControl + summary: >- + Gets the data of the content control when its type is `ComboBox`. + It's `null` otherwise. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;' + return: + type: >- + - name: contentControls uid: word!Word.Interfaces.ContentControlData#contentControls:member package: word! @@ -118,6 +137,27 @@ properties: content: 'contentControls?: Word.Interfaces.ContentControlData[];' return: type: [] + - name: dropDownListContentControl + uid: word!Word.Interfaces.ContentControlData#dropDownListContentControl:member + package: word! + fullName: dropDownListContentControl + summary: >- + Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: >- + dropDownListContentControl?: + Word.Interfaces.DropDownListContentControlData; + return: + type: >- + - name: fields uid: word!Word.Interfaces.ContentControlData#fields:member package: word! diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemcollectionloadoptions.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemcollectionloadoptions.yml new file mode 100644 index 0000000000..6464468310 --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemcollectionloadoptions.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: Word.Interfaces.ContentControlListItemCollectionLoadOptions +uid: word!Word.Interfaces.ContentControlListItemCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.ContentControlListItemCollectionLoadOptions +summary: >- + Contains a collection of + [Word.ContentControlListItem](xref:word!Word.ContentControlListItem:class) + objects that represent the items in a dropdown list or combo box content + control. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + word!Word.Interfaces.ContentControlListItemCollectionLoadOptions#$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: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: displayText + uid: >- + word!Word.Interfaces.ContentControlListItemCollectionLoadOptions#displayText:member + package: word! + fullName: displayText + summary: >- + For EACH ITEM in the collection: Specifies the display text of a list item + for a dropdown list or combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayText?: boolean;' + return: + type: boolean + - name: index + uid: >- + word!Word.Interfaces.ContentControlListItemCollectionLoadOptions#index:member + package: word! + fullName: index + summary: >- + For EACH ITEM in the collection: Specifies the index location of a content + control list item in the collection of list items. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: value + uid: >- + word!Word.Interfaces.ContentControlListItemCollectionLoadOptions#value:member + package: word! + fullName: value + summary: >- + For EACH ITEM in the collection: Specifies the programmatic value of a + list item for a dropdown list or combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemdata.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemdata.yml index 94e1bceaa5..07709acc4e 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemdata.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemdata.yml @@ -11,3 +11,55 @@ remarks: '' isPreview: false isDeprecated: false type: interface +properties: + - name: displayText + uid: word!Word.Interfaces.ContentControlListItemData#displayText:member + package: word! + fullName: displayText + summary: >- + Specifies the display text of a list item for a dropdown list or combo box + content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayText?: string;' + return: + type: string + - name: index + uid: word!Word.Interfaces.ContentControlListItemData#index:member + package: word! + fullName: index + summary: >- + Specifies the index location of a content control list item in the + collection of list items. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: value + uid: word!Word.Interfaces.ContentControlListItemData#value:member + package: word! + fullName: value + summary: >- + Specifies the programmatic value of a list item for a dropdown list or + combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemloadoptions.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemloadoptions.yml new file mode 100644 index 0000000000..791aae47ee --- /dev/null +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemloadoptions.yml @@ -0,0 +1,81 @@ +### YamlMime:TSType +name: Word.Interfaces.ContentControlListItemLoadOptions +uid: word!Word.Interfaces.ContentControlListItemLoadOptions:interface +package: word! +fullName: Word.Interfaces.ContentControlListItemLoadOptions +summary: Represents a list item in a dropdown list or combo box content control. +remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.ContentControlListItemLoadOptions#$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: false + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: displayText + uid: word!Word.Interfaces.ContentControlListItemLoadOptions#displayText:member + package: word! + fullName: displayText + summary: >- + Specifies the display text of a list item for a dropdown list or combo box + content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayText?: boolean;' + return: + type: boolean + - name: index + uid: word!Word.Interfaces.ContentControlListItemLoadOptions#index:member + package: word! + fullName: index + summary: >- + Specifies the index location of a content control list item in the + collection of list items. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: value + uid: word!Word.Interfaces.ContentControlListItemLoadOptions#value:member + package: word! + fullName: value + summary: >- + Specifies the programmatic value of a list item for a dropdown list or + combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemupdatedata.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemupdatedata.yml index 3136b4efd5..44777cd56f 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemupdatedata.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.interfaces.contentcontrollistitemupdatedata.yml @@ -11,3 +11,55 @@ remarks: '' isPreview: false isDeprecated: false type: interface +properties: + - name: displayText + uid: word!Word.Interfaces.ContentControlListItemUpdateData#displayText:member + package: word! + fullName: displayText + summary: >- + Specifies the display text of a list item for a dropdown list or combo box + content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'displayText?: string;' + return: + type: string + - name: index + uid: word!Word.Interfaces.ContentControlListItemUpdateData#index:member + package: word! + fullName: index + summary: >- + Specifies the index location of a content control list item in the + collection of list items. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: value + uid: word!Word.Interfaces.ContentControlListItemUpdateData#value:member + package: word! + fullName: value + summary: >- + Specifies the programmatic value of a list item for a dropdown list or + combo box content control. + remarks: >- + \[ [API set: WordApi + 1.9](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'value?: string;' + return: + type: string diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index 2e9a4661bc..098e4f2485 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -240,8 +240,8 @@ ||[validate()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-validate-member(1))|Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary).| |[CustomXmlValidationError](/javascript/api/word/word.customxmlvalidationerror)|[delete()](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-delete-member(1))|Deletes this `CustomXmlValidationError` object.| ||[errorCode](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-errorcode-member)|Gets an integer representing the validation error in the `CustomXmlValidationError` object.| -||[name](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing`| -||[node](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`.| +||[name](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.| +||[node](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.| ||[text](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-text-member)|Gets the text in the `CustomXmlValidationError` object.| ||[type](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-type-member)|Gets the type of error generated from the `CustomXmlValidationError` object.| |[CustomXmlValidationErrorCollection](/javascript/api/word/word.customxmlvalidationerrorcollection)|[add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions)](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-add-member(1))|Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object.| @@ -269,35 +269,335 @@ ||[tag](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-tag-member)|Specifies a tag to identify the content control.| ||[title](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-title-member)|Specifies the title for the content control.| ||[xmlMapping](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Document](/javascript/api/word/word.document)|[attachedTemplate](/javascript/api/word/word.document#word-word-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| +|[Document](/javascript/api/word/word.document)|[acceptAllRevisions()](/javascript/api/word/word.document#word-word-document-acceptallrevisions-member(1))|Accepts all tracked changes in the document.| +||[acceptAllRevisionsShown()](/javascript/api/word/word.document#word-word-document-acceptallrevisionsshown-member(1))|Accepts all revisions in the document that are displayed on the screen.| +||[activate()](/javascript/api/word/word.document#word-word-document-activate-member(1))|Activates the document so that it becomes the active document.| +||[activeTheme](/javascript/api/word/word.document#word-word-document-activetheme-member)|Gets the name of the active theme and formatting options.| +||[activeThemeDisplayName](/javascript/api/word/word.document#word-word-document-activethemedisplayname-member)|Gets the display name of the active theme.| +||[addToFavorites()](/javascript/api/word/word.document#word-word-document-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| +||[applyQuickStyleSet(style: Word.ApplyQuickStyleSet)](/javascript/api/word/word.document#word-word-document-applyquickstyleset-member(1))|Applies the specified Quick Style set to the document.| +||[applyTheme(name: string)](/javascript/api/word/word.document#word-word-document-applytheme-member(1))|Applies the specified theme to this document.| +||[areFilePropertiesPasswordEncrypted](/javascript/api/word/word.document#word-word-document-arefilepropertiespasswordencrypted-member)|Gets whether Word encrypts file properties for password-protected documents.| +||[areGrammaticalErrorsShown](/javascript/api/word/word.document#word-word-document-aregrammaticalerrorsshown-member)|Specifies whether grammatical errors are marked by a wavy green line in the document.| +||[areMathDefaultsUsed](/javascript/api/word/word.document#word-word-document-aremathdefaultsused-member)|Specifies whether to use the default math settings when creating new equations.| +||[areNewerFeaturesDisabled](/javascript/api/word/word.document#word-word-document-arenewerfeaturesdisabled-member)|Specifies whether to disable features introduced after a specified version.| +||[areSpellingErrorsShown](/javascript/api/word/word.document#word-word-document-arespellingerrorsshown-member)|Specifies whether Microsoft Word underlines spelling errors in the document.| +||[areStylesUpdatedOnOpen](/javascript/api/word/word.document#word-word-document-arestylesupdatedonopen-member)|Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened.| +||[areTrueTypeFontsEmbedded](/javascript/api/word/word.document#word-word-document-aretruetypefontsembedded-member)|Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved.| +||[attachedTemplate](/javascript/api/word/word.document#word-word-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| +||[autoFormat()](/javascript/api/word/word.document#word-word-document-autoformat-member(1))|Automatically formats the document.| ||[autoHyphenation](/javascript/api/word/word.document#word-word-document-autohyphenation-member)|Specifies if automatic hyphenation is turned on for the document.| ||[autoSaveOn](/javascript/api/word/word.document#word-word-document-autosaveon-member)|Specifies if the edits in the document are automatically saved.| +||[background](/javascript/api/word/word.document#word-word-document-background-member)|Gets a `Shape` object that represents the background image for the document.| ||[bibliography](/javascript/api/word/word.document#word-word-document-bibliography-member)|Returns a `Bibliography` object that represents the bibliography references contained within the document.| ||[bookmarks](/javascript/api/word/word.document#word-word-document-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the document.| +||[builtInDocumentProperties](/javascript/api/word/word.document#word-word-document-builtindocumentproperties-member)|Gets a `DocumentProperties` object that represents all the built-in document properties for the document.| +||[canCheckin()](/javascript/api/word/word.document#word-word-document-cancheckin-member(1))|Returns `true` if Microsoft Word can check in the document to a server.| +||[characters](/javascript/api/word/word.document#word-word-document-characters-member)|Gets the `RangeScopedCollection` object that represents all the characters in the document.| +||[checkConsistencyJapanese()](/javascript/api/word/word.document#word-word-document-checkconsistencyjapanese-member(1))|Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words.| +||[checkGrammar()](/javascript/api/word/word.document#word-word-document-checkgrammar-member(1))|Begins a spelling and grammar check for the document.| +||[checkIn(options?: Word.DocumentCheckInOptions)](/javascript/api/word/word.document#word-word-document-checkin-member(1))|Checks in the document from the local computer to a server and sets the local document to read-only so that it cannot be edited locally.| +||[checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions)](/javascript/api/word/word.document#word-word-document-checkinwithversion-member(1))|Saves the document to a server from a local computer, and sets the local document to read-only so that it cannot be edited locally.| +||[checkSpelling(options?: Word.DocumentCheckSpellingOptions)](/javascript/api/word/word.document#word-word-document-checkspelling-member(1))|Begins a spelling check for the document.| +||[closePrintPreview()](/javascript/api/word/word.document#word-word-document-closeprintpreview-member(1))|Switches the document from print preview to the previous view.| ||[coauthoring](/javascript/api/word/word.document#word-word-document-coauthoring-member)|Gets a `Coauthoring` object for managing coauthoring in the document.| +||[codeName](/javascript/api/word/word.document#word-word-document-codename-member)|Gets the code name for the document.| +||[comments](/javascript/api/word/word.document#word-word-document-comments-member)|Gets a `CommentCollection` object that represents all the comments in the document.| +||[compatibilityMode](/javascript/api/word/word.document#word-word-document-compatibilitymode-member)|Gets the compatibility mode that Word uses when opening the document.| +||[computeStatistics(statistic: Word.Statistic, includeFootnotesAndEndnotes?: boolean)](/javascript/api/word/word.document#word-word-document-computestatistics-member(1))|Returns a statistic based on the contents of the document.| ||[consecutiveHyphensLimit](/javascript/api/word/word.document#word-word-document-consecutivehyphenslimit-member)|Specifies the maximum number of consecutive lines that can end with hyphens.| +||[content](/javascript/api/word/word.document#word-word-document-content-member)|Gets a `Range` object that represents the main document story.| +||[convert()](/javascript/api/word/word.document#word-word-document-convert-member(1))|Converts the file to the newest format and enables all features.| +||[convertAutoHyphens()](/javascript/api/word/word.document#word-word-document-convertautohyphens-member(1))|Converts automatic hyphens to manual hyphens.| +||[convertNumbersToText(numberType?: Word.NumberType)](/javascript/api/word/word.document#word-word-document-convertnumberstotext-member(1))|Changes the list numbers and LISTNUM fields in the document to text.| +||[convertVietnameseDocument(codePageOrigin: number)](/javascript/api/word/word.document#word-word-document-convertvietnamesedocument-member(1))|Reconverts a Vietnamese document to Unicode using a code page other than the default.| +||[copyStylesFromTemplate(StyleTemplate: string)](/javascript/api/word/word.document#word-word-document-copystylesfromtemplate-member(1))|Copies styles from the specified template to the document.| +||[countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions)](/javascript/api/word/word.document#word-word-document-countnumbereditems-member(1))|Returns the number of bulleted or numbered items and LISTNUM fields in the document.| +||[currentRsid](/javascript/api/word/word.document#word-word-document-currentrsid-member)|Gets a random number that Word assigns to changes in the document.| +||[customDocumentProperties](/javascript/api/word/word.document#word-word-document-customdocumentproperties-member)|Gets a `DocumentProperties` collection that represents all the custom document properties for the document.| +||[defaultTabStop](/javascript/api/word/word.document#word-word-document-defaulttabstop-member)|Specifies the interval (in points) between the default tab stops in the document.| +||[defaultTargetFrame](/javascript/api/word/word.document#word-word-document-defaulttargetframe-member)|Specifies the browser frame for displaying a webpage via hyperlink.| +||[deleteAllComments()](/javascript/api/word/word.document#word-word-document-deleteallcomments-member(1))|Deletes all comments from the document.| +||[deleteAllCommentsShown()](/javascript/api/word/word.document#word-word-document-deleteallcommentsshown-member(1))|Deletes all revisions in the document that are displayed on the screen.| +||[deleteAllInkAnnotations()](/javascript/api/word/word.document#word-word-document-deleteallinkannotations-member(1))|Deletes all handwritten ink annotations in the document.| ||[detectLanguage()](/javascript/api/word/word.document#word-word-document-detectlanguage-member(1))|Analyzes the document text to determine the language.| +||[doNotEmbedSystemFonts](/javascript/api/word/word.document#word-word-document-donotembedsystemfonts-member)|Specifies whether Word should not embed common system fonts.| ||[documentLibraryVersions](/javascript/api/word/word.document#word-word-document-documentlibraryversions-member)|Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.| +||[encryptionProvider](/javascript/api/word/word.document#word-word-document-encryptionprovider-member)|Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents.| +||[endReview(options?: Word.DocumentEndReviewOptions)](/javascript/api/word/word.document#word-word-document-endreview-member(1))|Terminates a review of the file that has been sent for review.| +||[exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions)](/javascript/api/word/word.document#word-word-document-exportasfixedformat-member(1))|Saves the document in PDF or XPS format.| +||[exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options)](/javascript/api/word/word.document#word-word-document-exportasfixedformat2-member(1))|Saves the document in PDF or XPS format.| +||[exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options)](/javascript/api/word/word.document#word-word-document-exportasfixedformat3-member(1))|Saves the document in PDF or XPS format with improved tagging.| +||[farEastLineBreakLanguage](/javascript/api/word/word.document#word-word-document-fareastlinebreaklanguage-member)|Specifies the East Asian language used for line breaking.| +||[farEastLineBreakLevel](/javascript/api/word/word.document#word-word-document-fareastlinebreaklevel-member)|Specifies the line break control level.| +||[fields](/javascript/api/word/word.document#word-word-document-fields-member)|Gets a `FieldCollection` object that represents all the fields in the document.| +||[fitToPages()](/javascript/api/word/word.document#word-word-document-fittopages-member(1))|Decreases the font size of text just enough so that the document page count drops by one.| +||[followHyperlink(options?: Word.DocumentFollowHyperlinkOptions)](/javascript/api/word/word.document#word-word-document-followhyperlink-member(1))|Displays a cached document, if it has already been downloaded.| +||[formattingIsNextLevelShown](/javascript/api/word/word.document#word-word-document-formattingisnextlevelshown-member)|Specifies whether Word shows the next heading level when the previous is used.| +||[formattingIsUserStyleNameShown](/javascript/api/word/word.document#word-word-document-formattingisuserstylenameshown-member)|Specifies whether to show user-defined styles.| ||[frames](/javascript/api/word/word.document#word-word-document-frames-member)|Returns a `FrameCollection` object that represents all the frames in the document.| +||[freezeLayout()](/javascript/api/word/word.document#word-word-document-freezelayout-member(1))|Fixes the layout of the document in Web view.| +||[fullName](/javascript/api/word/word.document#word-word-document-fullname-member)|Gets the name of a document, including the path.| +||[getCrossReferenceItems(referenceType: Word.ReferenceType)](/javascript/api/word/word.document#word-word-document-getcrossreferenceitems-member(1))|Returns an array of items that can be cross-referenced based on the specified cross-reference type.| +||[getRange(options?: Word.DocumentRangeOptions)](/javascript/api/word/word.document#word-word-document-getrange-member(1))|Returns a `Range` object by using the specified starting and ending character positions.| +||[goTo(options?: Word.GoToOptions)](/javascript/api/word/word.document#word-word-document-goto-member(1))|Returns a `Range` object that represents the start position of the specified item, such as a page, bookmark, or field.| +||[grammaticalErrors](/javascript/api/word/word.document#word-word-document-grammaticalerrors-member)|Gets a `RangeCollection` object that represents the sentences that failed the grammar check in the document.| +||[gridDistanceHorizontal](/javascript/api/word/word.document#word-word-document-griddistancehorizontal-member)|Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.| +||[gridDistanceVertical](/javascript/api/word/word.document#word-word-document-griddistancevertical-member)|Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document.| +||[gridIsOriginFromMargin](/javascript/api/word/word.document#word-word-document-gridisoriginfrommargin-member)|Specifies whether the character grid starts from the upper-left corner of the page.| +||[gridOriginHorizontal](/javascript/api/word/word.document#word-word-document-gridoriginhorizontal-member)|Specifies the horizontal origin point for the invisible grid.| +||[gridOriginVertical](/javascript/api/word/word.document#word-word-document-gridoriginvertical-member)|Specifies the vertical origin point for the invisible grid.| +||[gridSpaceBetweenHorizontalLines](/javascript/api/word/word.document#word-word-document-gridspacebetweenhorizontallines-member)|Specifies the interval for horizontal character gridlines in print layout view.| +||[gridSpaceBetweenVerticalLines](/javascript/api/word/word.document#word-word-document-gridspacebetweenverticallines-member)|Specifies the interval for vertical character gridlines in print layout view.| +||[hasPassword](/javascript/api/word/word.document#word-word-document-haspassword-member)|Gets whether a password is required to open the document.| +||[hasVbProject](/javascript/api/word/word.document#word-word-document-hasvbproject-member)|Gets whether the document has an attached Microsoft Visual Basic for Applications project.| ||[hyperlinks](/javascript/api/word/word.document#word-word-document-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document.| ||[hyphenateCaps](/javascript/api/word/word.document#word-word-document-hyphenatecaps-member)|Specifies whether words in all capital letters can be hyphenated.| +||[hyphenationZone](/javascript/api/word/word.document#word-word-document-hyphenationzone-member)|Specifies the width of the hyphenation zone, in points.| ||[indexes](/javascript/api/word/word.document#word-word-document-indexes-member)|Returns an `IndexCollection` object that represents all the indexes in the document.| +||[isAutoFormatOverrideOn](/javascript/api/word/word.document#word-word-document-isautoformatoverrideon-member)|Specifies whether automatic formatting options override formatting restrictions.| +||[isChartDataPointTracked](/javascript/api/word/word.document#word-word-document-ischartdatapointtracked-member)|Specifies whether charts in the active document use cell-reference data-point tracking.| +||[isCompatible](/javascript/api/word/word.document#word-word-document-iscompatible-member)|Specifies whether the compatibility option specified by the `type` property is enabled.| +||[isFinal](/javascript/api/word/word.document#word-word-document-isfinal-member)|Specifies whether the document is final.| +||[isFontsSubsetSaved](/javascript/api/word/word.document#word-word-document-isfontssubsetsaved-member)|Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document.| +||[isFormsDataPrinted](/javascript/api/word/word.document#word-word-document-isformsdataprinted-member)|Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form.| +||[isFormsDataSaved](/javascript/api/word/word.document#word-word-document-isformsdatasaved-member)|Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database.| +||[isGrammarChecked](/javascript/api/word/word.document#word-word-document-isgrammarchecked-member)|Specifies whether a grammar check has been run on the document.| +||[isInAutoSave](/javascript/api/word/word.document#word-word-document-isinautosave-member)|Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user.| +||[isInFormsDesign](/javascript/api/word/word.document#word-word-document-isinformsdesign-member)|Gets whether the document is in form design mode.| +||[isKerningByAlgorithm](/javascript/api/word/word.document#word-word-document-iskerningbyalgorithm-member)|Specifies whether Word kerns half-width Latin characters and punctuation marks.| +||[isLinguisticDataEmbedded](/javascript/api/word/word.document#word-word-document-islinguisticdataembedded-member)|Specifies whether to embed speech and handwriting data.| +||[isMasterDocument](/javascript/api/word/word.document#word-word-document-ismasterdocument-member)|Gets whether this document is a master document.| +||[isOptimizedForWord97](/javascript/api/word/word.document#word-word-document-isoptimizedforword97-member)|Specifies whether Word optimizes the document for Word 97.| +||[isPostScriptPrintedOverText](/javascript/api/word/word.document#word-word-document-ispostscriptprintedovertext-member)|Specifies whether PRINT field instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used.| +||[isQuickStyleSetLocked](/javascript/api/word/word.document#word-word-document-isquickstylesetlocked-member)|Specifies whether users can change the Quick Style set.| +||[isReadOnly](/javascript/api/word/word.document#word-word-document-isreadonly-member)|Gets whether changes to the document cannot be saved to the original document.| +||[isReadOnlyRecommended](/javascript/api/word/word.document#word-word-document-isreadonlyrecommended-member)|Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only.| +||[isSnappedToGrid](/javascript/api/word/word.document#word-word-document-issnappedtogrid-member)|Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid.| +||[isSnappedToShapes](/javascript/api/word/word.document#word-word-document-issnappedtoshapes-member)|Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes.| +||[isSpellingChecked](/javascript/api/word/word.document#word-word-document-isspellingchecked-member)|Specifies whether spelling has been checked throughout the document.| +||[isStyleEnforced](/javascript/api/word/word.document#word-word-document-isstyleenforced-member)|Specifies whether formatting restrictions are enforced in a protected document.| +||[isSubdocument](/javascript/api/word/word.document#word-word-document-issubdocument-member)|Gets whether this document is a subdocument of a master document.| +||[isThemeLocked](/javascript/api/word/word.document#word-word-document-isthemelocked-member)|Specifies whether users can change the document theme.| +||[isUserControl](/javascript/api/word/word.document#word-word-document-isusercontrol-member)|Specifies whether the document was created or opened by the user.| +||[isVbaSigned](/javascript/api/word/word.document#word-word-document-isvbasigned-member)|Gets whether the VBA project is digitally signed.| +||[isWriteReserved](/javascript/api/word/word.document#word-word-document-iswritereserved-member)|Gets whether the document is protected with a write password.| +||[justificationMode](/javascript/api/word/word.document#word-word-document-justificationmode-member)|Specifies the character spacing adjustment.| +||[kind](/javascript/api/word/word.document#word-word-document-kind-member)|Specifies the format type that Microsoft Word uses when automatically formatting the document.| ||[languageDetected](/javascript/api/word/word.document#word-word-document-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the document text.| +||[listParagraphs](/javascript/api/word/word.document#word-word-document-listparagraphs-member)|Gets a `ParagraphCollection` object that represents all the numbered paragraphs in the document.| ||[listTemplates](/javascript/api/word/word.document#word-word-document-listtemplates-member)|Returns a `ListTemplateCollection` object that represents all the list templates in the document.| +||[lists](/javascript/api/word/word.document#word-word-document-lists-member)|Gets a `ListCollection` object that contains all the formatted lists in the document.| +||[lockServerFile()](/javascript/api/word/word.document#word-word-document-lockserverfile-member(1))|Locks the file on the server preventing anyone else from editing it.| +||[makeCompatibilityDefault()](/javascript/api/word/word.document#word-word-document-makecompatibilitydefault-member(1))|Sets the compatibility options.| ||[manualHyphenation()](/javascript/api/word/word.document#word-word-document-manualhyphenation-member(1))|Initiates manual hyphenation of a document, one line at a time.| +||[merge(fileName: string, options?: Word.DocumentMergeOptions)](/javascript/api/word/word.document#word-word-document-merge-member(1))|Merges the changes marked with revision marks from one document to another.| +||[noLineBreakAfter](/javascript/api/word/word.document#word-word-document-nolinebreakafter-member)|Specifies the kinsoku characters after which Word will not break a line.| +||[noLineBreakBefore](/javascript/api/word/word.document#word-word-document-nolinebreakbefore-member)|Specifies the kinsoku characters before which Word will not break a line.| +||[openEncoding](/javascript/api/word/word.document#word-word-document-openencoding-member)|Gets the encoding used to open the document.| +||[originalDocumentTitle](/javascript/api/word/word.document#word-word-document-originaldocumenttitle-member)|Gets the title of the original document after legal-blackline comparison.| ||[pageSetup](/javascript/api/word/word.document#word-word-document-pagesetup-member)|Returns a `PageSetup` object that's associated with the document.| +||[paragraphs](/javascript/api/word/word.document#word-word-document-paragraphs-member)|Gets a `ParagraphCollection` object that represents all the paragraphs in the document.| +||[password](/javascript/api/word/word.document#word-word-document-password-member)|Sets a password that must be supplied to open the document.| +||[passwordEncryptionAlgorithm](/javascript/api/word/word.document#word-word-document-passwordencryptionalgorithm-member)|Gets the algorithm used for password encryption.| +||[passwordEncryptionKeyLength](/javascript/api/word/word.document#word-word-document-passwordencryptionkeylength-member)|Gets the key length used for password encryption.| +||[passwordEncryptionProvider](/javascript/api/word/word.document#word-word-document-passwordencryptionprovider-member)|Gets the name of the password encryption provider.| +||[path](/javascript/api/word/word.document#word-word-document-path-member)|Gets the disk or the web path to the document (excludes the document name).| +||[post()](/javascript/api/word/word.document#word-word-document-post-member(1))|Posts the document to a public folder in Microsoft Exchange.| +||[presentIt()](/javascript/api/word/word.document#word-word-document-presentit-member(1))|Opens PowerPoint with the Word document loaded.| +||[printOut(options?: Word.DocumentPrintOutOptions)](/javascript/api/word/word.document#word-word-document-printout-member(1))|Prints all or part of the document.| +||[printPreview()](/javascript/api/word/word.document#word-word-document-printpreview-member(1))|Switches the view to print preview.| +||[printRevisions](/javascript/api/word/word.document#word-word-document-printrevisions-member)|Specifies whether revision marks are printed with the document.| +||[protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions)](/javascript/api/word/word.document#word-word-document-protect-member(1))|Protects the document from unauthorized changes.| +||[protectionType](/javascript/api/word/word.document#word-word-document-protectiontype-member)|Gets the protection type for the document.| +||[readabilityStatistics](/javascript/api/word/word.document#word-word-document-readabilitystatistics-member)|Gets a `ReadabilityStatisticCollection` object that represents the readability statistics for the document.| +||[readingLayoutSizeX](/javascript/api/word/word.document#word-word-document-readinglayoutsizex-member)|Specifies the width of pages in reading layout view when frozen.| +||[readingLayoutSizeY](/javascript/api/word/word.document#word-word-document-readinglayoutsizey-member)|Specifies the height of pages in reading layout view when frozen.| +||[readingModeIsLayoutFrozen](/javascript/api/word/word.document#word-word-document-readingmodeislayoutfrozen-member)|Specifies whether pages in reading layout view are frozen for handwritten markup.| +||[redo(times?: number)](/javascript/api/word/word.document#word-word-document-redo-member(1))|Redoes the last action that was undone (reverses the `undo` method).| +||[rejectAllRevisions()](/javascript/api/word/word.document#word-word-document-rejectallrevisions-member(1))|Rejects all tracked changes in the document.| +||[rejectAllRevisionsShown()](/javascript/api/word/word.document#word-word-document-rejectallrevisionsshown-member(1))|Rejects all revisions in the document that are displayed on the screen.| +||[reload()](/javascript/api/word/word.document#word-word-document-reload-member(1))|Reloads a cached document by resolving the hyperlink to the document and downloading it.| +||[reloadAs(encoding: Word.DocumentEncoding)](/javascript/api/word/word.document#word-word-document-reloadas-member(1))|Reloads the document based on an HTML document, using the document encoding.| +||[removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType)](/javascript/api/word/word.document#word-word-document-removedocumentinformation-member(1))|Removes sensitive information, properties, comments, and other metadata from the document.| +||[removeLockedStyles()](/javascript/api/word/word.document#word-word-document-removelockedstyles-member(1))|Purges the document of locked styles when formatting restrictions have been applied in the document.| +||[removeNumbers(numberType?: Word.NumberType)](/javascript/api/word/word.document#word-word-document-removenumbers-member(1))|Removes numbers or bullets from the document.| +||[removePersonalInformationOnSave](/javascript/api/word/word.document#word-word-document-removepersonalinformationonsave-member)|Specifies whether Word removes user information upon saving.| +||[removeTheme()](/javascript/api/word/word.document#word-word-document-removetheme-member(1))|Removes the active theme from the current document.| +||[repaginate()](/javascript/api/word/word.document#word-word-document-repaginate-member(1))|Repaginates the entire document.| +||[replyWithChanges(options?: Word.DocumentReplyWithChangesOptions)](/javascript/api/word/word.document#word-word-document-replywithchanges-member(1))|Sends an email message to the author of the document that has been sent out for review, notifying them that a reviewer has completed review of the document.| +||[resetFormFields()](/javascript/api/word/word.document#word-word-document-resetformfields-member(1))|Clears all form fields in the document, preparing the form to be filled in again.| +||[returnToLastReadPosition()](/javascript/api/word/word.document#word-word-document-returntolastreadposition-member(1))|Returns the document to the last saved reading position.| +||[revisedDocumentTitle](/javascript/api/word/word.document#word-word-document-reviseddocumenttitle-member)|Gets the title of the revised document after legal-blackline comparison.| ||[revisions](/javascript/api/word/word.document#word-word-document-revisions-member)|Gets the collection of revisions that represents the tracked changes in the document.| +||[runAutoMacro(autoMacro: Word.AutoMacro)](/javascript/api/word/word.document#word-word-document-runautomacro-member(1))|Runs an auto macro that's stored in the document.| +||[saveAsQuickStyleSet(fileName: string)](/javascript/api/word/word.document#word-word-document-saveasquickstyleset-member(1))|Saves the group of quick styles currently in use.| +||[saveEncoding](/javascript/api/word/word.document#word-word-document-saveencoding-member)|Specifies the encoding used when saving the document.| +||[saveFormat](/javascript/api/word/word.document#word-word-document-saveformat-member)|Gets the file format of the document.| +||[select()](/javascript/api/word/word.document#word-word-document-select-member(1))|Selects the contents of the document.| +||[selectContentControlsByTag(tag: string)](/javascript/api/word/word.document#word-word-document-selectcontentcontrolsbytag-member(1))|Returns all content controls with the specified tag.| +||[selectContentControlsByTitle(title: string)](/javascript/api/word/word.document#word-word-document-selectcontentcontrolsbytitle-member(1))|Returns a `ContentControlCollection` object that represents all the content controls in the document with the specified title.| +||[selectLinkedControls(node: Word.CustomXmlNode)](/javascript/api/word/word.document#word-word-document-selectlinkedcontrols-member(1))|Returns a `ContentControlCollection` object that represents all content controls in the document that are linked to the specific custom XML node.| +||[selectNodes(xPath: string, options?: Word.SelectNodesOptions)](/javascript/api/word/word.document#word-word-document-selectnodes-member(1))|Returns an `XmlNodeCollection` object that represents all the nodes that match the XPath parameter in the order in which they appear in the document.| +||[selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions)](/javascript/api/word/word.document#word-word-document-selectsinglenode-member(1))|Returns an `XmlNode` object that represents the first node that matches the XPath parameter in the document.| +||[selectUnlinkedControls(stream?: Word.CustomXmlPart)](/javascript/api/word/word.document#word-word-document-selectunlinkedcontrols-member(1))|Returns a `ContentControlCollection` object that represents all content controls in the document that are not linked to an XML node.| ||[selection](/javascript/api/word/word.document#word-word-document-selection-member)|Returns a `Selection` object that represents the current selection in the document.| +||[sendFax(address: string, subject?: string)](/javascript/api/word/word.document#word-word-document-sendfax-member(1))|Sends the document as a fax, without any user interaction.| +||[sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions)](/javascript/api/word/word.document#word-word-document-sendfaxoverinternet-member(1))|Sends the document to a fax service provider, who faxes the document to one or more specified recipients.| +||[sendForReview(options?: Word.DocumentSendForReviewOptions)](/javascript/api/word/word.document#word-word-document-sendforreview-member(1))|Sends the document in an email message for review by the specified recipients.| +||[sendMail()](/javascript/api/word/word.document#word-word-document-sendmail-member(1))|Opens a message window for sending the document through Microsoft Exchange.| +||[sentences](/javascript/api/word/word.document#word-word-document-sentences-member)|Gets the `RangeScopedCollection` object that represents all the sentences in the document.| +||[setDefaultTableStyle(style: string, setInTemplate: boolean)](/javascript/api/word/word.document#word-word-document-setdefaulttablestyle-member(1))|Specifies the table style to use for newly created tables in the document.| +||[setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean)](/javascript/api/word/word.document#word-word-document-setpasswordencryptionoptions-member(1))|Sets the options Microsoft Word uses for encrypting documents with passwords.| +||[spellingErrors](/javascript/api/word/word.document#word-word-document-spellingerrors-member)|Gets a `RangeCollection` object that represents the words identified as spelling errors in the document.| +||[storyRanges](/javascript/api/word/word.document#word-word-document-storyranges-member)|Gets a `RangeCollection` object that represents all the stories in the document.| +||[styles](/javascript/api/word/word.document#word-word-document-styles-member)|Gets a `StyleCollection` for the document.| ||[tableOfAuthoritiesCategories](/javascript/api/word/word.document#word-word-document-tableofauthoritiescategories-member)|Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document.| +||[tables](/javascript/api/word/word.document#word-word-document-tables-member)|Gets a `TableCollection` object that represents all the tables in the document.| ||[tablesOfAuthorities](/javascript/api/word/word.document#word-word-document-tablesofauthorities-member)|Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document.| ||[tablesOfContents](/javascript/api/word/word.document#word-word-document-tablesofcontents-member)|Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document.| ||[tablesOfFigures](/javascript/api/word/word.document#word-word-document-tablesoffigures-member)|Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document.| +||[textEncoding](/javascript/api/word/word.document#word-word-document-textencoding-member)|Specifies the encoding for saving as encoded text.| +||[textLineEnding](/javascript/api/word/word.document#word-word-document-textlineending-member)|Specifies how Word marks line and paragraph breaks in text files.| +||[toggleFormsDesign()](/javascript/api/word/word.document#word-word-document-toggleformsdesign-member(1))|Switches form design mode on or off.| +||[trackFormatting](/javascript/api/word/word.document#word-word-document-trackformatting-member)|Specifies whether to track formatting changes when change tracking is on.| +||[trackMoves](/javascript/api/word/word.document#word-word-document-trackmoves-member)|Specifies whether to mark moved text when Track Changes is on.| +||[trackRevisions](/javascript/api/word/word.document#word-word-document-trackrevisions-member)|Specifies whether changes are tracked in the document.| +||[trackedChangesAreDateAndTimeRemoved](/javascript/api/word/word.document#word-word-document-trackedchangesaredateandtimeremoved-member)|Specifies whether to remove or store date and time metadata for tracked changes.| +||[transformDocument(path: string, dataOnly?: boolean)](/javascript/api/word/word.document#word-word-document-transformdocument-member(1))|Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results.| +||[type](/javascript/api/word/word.document#word-word-document-type-member)|Gets the document type (template or document).| +||[undo(times?: number)](/javascript/api/word/word.document#word-word-document-undo-member(1))|Undoes the last action or a sequence of actions, which are displayed in the Undo list.| +||[undoClear()](/javascript/api/word/word.document#word-word-document-undoclear-member(1))|Clears the list of actions that can be undone in the document.| +||[unprotect(password?: string)](/javascript/api/word/word.document#word-word-document-unprotect-member(1))|Removes protection from the document.| +||[updateStyles()](/javascript/api/word/word.document#word-word-document-updatestyles-member(1))|Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name.| +||[viewCode()](/javascript/api/word/word.document#word-word-document-viewcode-member(1))|Displays the code window for the selected Microsoft ActiveX control in the document.| +||[viewPropertyBrowser()](/javascript/api/word/word.document#word-word-document-viewpropertybrowser-member(1))|Displays the property window for the selected Microsoft ActiveX control in the document.| +||[webPagePreview()](/javascript/api/word/word.document#word-word-document-webpagepreview-member(1))|Displays a preview of the current document as it would look if saved as a webpage.| +||[webSettings](/javascript/api/word/word.document#word-word-document-websettings-member)|Gets the `WebSettings` object for webpage-related attributes.| +||[words](/javascript/api/word/word.document#word-word-document-words-member)|Gets the `RangeScopedCollection` object that represents each word in the document.| +||[writePassword](/javascript/api/word/word.document#word-word-document-writepassword-member)|Sets a password for saving changes to the document.| +||[xmlAreAdvancedErrorsShown](/javascript/api/word/word.document#word-word-document-xmlareadvancederrorsshown-member)|Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML).| +||[xmlIsXsltUsedWhenSaving](/javascript/api/word/word.document#word-word-document-xmlisxsltusedwhensaving-member)|Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT).| +||[xmlSaveThroughXSLT](/javascript/api/word/word.document#word-word-document-xmlsavethroughxslt-member)|Specifies the path and file name for the XSLT to apply when saving a document.| +|[DocumentCheckInOptions](/javascript/api/word/word.documentcheckinoptions)|[comment](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-comment-member)|If provided, specifies a comment for the check-in operation.| +||[makePublic](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-makepublic-member)|If provided, specifies whether to make the document public after check-in.| +||[saveChanges](/javascript/api/word/word.documentcheckinoptions#word-word-documentcheckinoptions-savechanges-member)|If provided, specifies whether to save changes before checking in.| +|[DocumentCheckInWithVersionOptions](/javascript/api/word/word.documentcheckinwithversionoptions)|[comment](/javascript/api/word/word.documentcheckinwithversionoptions#word-word-documentcheckinwithversionoptions-comment-member)|If provided, specifies a comment for the check-in operation.| +||[makePublic](/javascript/api/word/word.documentcheckinwithversionoptions#word-word-documentcheckinwithversionoptions-makepublic-member)|If provided, specifies whether to make the document public after check-in.| +||[saveChanges](/javascript/api/word/word.documentcheckinwithversionoptions#word-word-documentcheckinwithversionoptions-savechanges-member)|If provided, specifies whether to save changes before checking in.| +||[versionType](/javascript/api/word/word.documentcheckinwithversionoptions#word-word-documentcheckinwithversionoptions-versiontype-member)|If provided, specifies the version type for the check-in.| +|[DocumentCheckSpellingOptions](/javascript/api/word/word.documentcheckspellingoptions)|[alwaysSuggest](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-alwayssuggest-member)|If provided, specifies whether to always suggest spelling corrections.| +||[customDictionary10](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary10-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary2](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary2-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary3](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary3-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary4](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary4-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary5](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary5-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary6](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary6-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary7](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary7-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary8](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary8-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary9](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary9-member)|If provided, specifies an additional custom dictionary to use for spell checking.| +||[customDictionary](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-customdictionary-member)|If provided, specifies the custom dictionary to use for spell checking.| +||[ignoreUppercase](/javascript/api/word/word.documentcheckspellingoptions#word-word-documentcheckspellingoptions-ignoreuppercase-member)|If provided, specifies whether to ignore uppercase words during spell checking.| +|[DocumentCountNumberedItemsOptions](/javascript/api/word/word.documentcountnumbereditemsoptions)|[level](/javascript/api/word/word.documentcountnumbereditemsoptions#word-word-documentcountnumbereditemsoptions-level-member)|If provided, specifies the level of numbering to count.| +||[numberType](/javascript/api/word/word.documentcountnumbereditemsoptions#word-word-documentcountnumbereditemsoptions-numbertype-member)|If provided, specifies the type of numbered items to count.| +|[DocumentEndReviewOptions](/javascript/api/word/word.documentendreviewoptions)|[includeAttachment](/javascript/api/word/word.documentendreviewoptions#word-word-documentendreviewoptions-includeattachment-member)|If provided, specifies whether to include the document as an attachment.| +||[recipients](/javascript/api/word/word.documentendreviewoptions#word-word-documentendreviewoptions-recipients-member)|If provided, specifies the recipients to notify when ending the review.| +||[showMessage](/javascript/api/word/word.documentendreviewoptions#word-word-documentendreviewoptions-showmessage-member)|If provided, specifies whether to show the message before sending.| +||[subject](/javascript/api/word/word.documentendreviewoptions#word-word-documentendreviewoptions-subject-member)|If provided, specifies the subject of the notification email.| +|[DocumentExportAsFixedFormat2Options](/javascript/api/word/word.documentexportasfixedformat2options)|[bitmapMissingFonts](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-bitmapmissingfonts-member)|If provided, specifies whether to bitmap missing fonts.| +||[createBookmarks](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-createbookmarks-member)|If provided, specifies the bookmark creation mode.| +||[documentStructureTags](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-documentstructuretags-member)|If provided, specifies whether to include document structure tags.| +||[fixedFormatExtClassPtr](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-fixedformatextclassptr-member)|If provided, specifies the extension class pointer.| +||[from](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-from-member)|If provided, specifies the starting page number.| +||[includeDocProps](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-includedocprops-member)|If provided, specifies whether to include document properties.| +||[item](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-item-member)|If provided, specifies the item to export.| +||[keepInformationRightsManagement](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-keepinformationrightsmanagement-member)|If provided, specifies whether to keep Information Rights Management (IRM) settings.| +||[openAfterExport](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-openafterexport-member)|If provided, specifies whether to open the file after export.| +||[optimizeFor](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-optimizefor-member)|If provided, specifies the optimization target for the export.| +||[optimizeForImageQuality](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-optimizeforimagequality-member)|If provided, specifies whether to optimize for image quality in the exported file.| +||[range](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-range-member)|If provided, specifies the range to export.| +||[to](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-to-member)|If provided, specifies the ending page number.| +||[useIso19005_1](/javascript/api/word/word.documentexportasfixedformat2options#word-word-documentexportasfixedformat2options-useiso19005_1-member)|If provided, specifies whether to use ISO 19005-1 compliance.| +|[DocumentExportAsFixedFormat3Options](/javascript/api/word/word.documentexportasfixedformat3options)|[bitmapMissingFonts](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-bitmapmissingfonts-member)|If provided, specifies whether to bitmap missing fonts.| +||[createBookmarks](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-createbookmarks-member)|If provided, specifies the bookmark creation mode.| +||[documentStructureTags](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-documentstructuretags-member)|If provided, specifies whether to include document structure tags.| +||[fixedFormatExtClassPtr](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-fixedformatextclassptr-member)|If provided, specifies the extension class pointer.| +||[from](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-from-member)|If provided, specifies the starting page number.| +||[improveExportTagging](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-improveexporttagging-member)|If provided, specifies to improve export tagging for better accessibility.| +||[includeDocProps](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-includedocprops-member)|If provided, specifies whether to include document properties.| +||[item](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-item-member)|If provided, specifies the item to export.| +||[keepInformationRightsManagement](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-keepinformationrightsmanagement-member)|If provided, specifies whether to keep Information Rights Management (IRM) settings.| +||[openAfterExport](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-openafterexport-member)|If provided, specifies whether to open the file after export.| +||[optimizeFor](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-optimizefor-member)|If provided, specifies the optimization target for the export.| +||[optimizeForImageQuality](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-optimizeforimagequality-member)|If provided, specifies whether to optimize for image quality in the exported file.| +||[range](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-range-member)|If provided, specifies the range to export.| +||[to](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-to-member)|If provided, specifies the ending page number.| +||[useIso19005_1](/javascript/api/word/word.documentexportasfixedformat3options#word-word-documentexportasfixedformat3options-useiso19005_1-member)|If provided, specifies whether to use ISO 19005-1 compliance.| +|[DocumentExportAsFixedFormatOptions](/javascript/api/word/word.documentexportasfixedformatoptions)|[bitmapMissingFonts](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-bitmapmissingfonts-member)|If provided, specifies whether to bitmap missing fonts.| +||[createBookmarks](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-createbookmarks-member)|If provided, specifies the bookmark creation mode.| +||[documentStructureTags](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-documentstructuretags-member)|If provided, specifies whether to include document structure tags.| +||[fixedFormatExtensionClassPointer](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-fixedformatextensionclasspointer-member)|If provided, specifies the extension class pointer.| +||[from](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-from-member)|If provided, specifies the starting page number.| +||[includeDocProps](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-includedocprops-member)|If provided, specifies whether to include document properties.| +||[item](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-item-member)|If provided, specifies the item to export.| +||[keepInformationRightsManagement](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-keepinformationrightsmanagement-member)|If provided, specifies whether to keep Information Rights Management (IRM) settings.| +||[openAfterExport](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-openafterexport-member)|If provided, specifies whether to open the file after export.| +||[optimizeFor](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-optimizefor-member)|If provided, specifies the optimization target for the export.| +||[range](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-range-member)|If provided, specifies the range to export.| +||[to](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-to-member)|If provided, specifies the ending page number.| +||[useIso19005_1](/javascript/api/word/word.documentexportasfixedformatoptions#word-word-documentexportasfixedformatoptions-useiso19005_1-member)|If provided, specifies whether to use ISO 19005-1 compliance.| +|[DocumentFollowHyperlinkOptions](/javascript/api/word/word.documentfollowhyperlinkoptions)|[addHistory](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-addhistory-member)|If provided, specifies whether to add the link to the browsing history.| +||[address](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-address-member)|If provided, specifies the hyperlink address to follow.| +||[extraInfo](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-extrainfo-member)|If provided, specifies additional information to pass with the request.| +||[headerInfo](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-headerinfo-member)|If provided, specifies header information for the HTTP request.| +||[httpMethod](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-httpmethod-member)|If provided, specifies the HTTP method to use for the request.| +||[newWindow](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-newwindow-member)|If provided, specifies whether to open the link in a new window.| +||[subAddress](/javascript/api/word/word.documentfollowhyperlinkoptions#word-word-documentfollowhyperlinkoptions-subaddress-member)|If provided, specifies the sub-address within the document.| |[DocumentLibraryVersion](/javascript/api/word/word.documentlibraryversion)|[comments](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-comments-member)|Gets any optional comments associated with this version of the shared document.| ||[modified](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modified-member)|Gets the date and time at which this version of the shared document was last saved to the server.| ||[modifiedBy](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modifiedby-member)|Gets the name of the user who last saved this version of the shared document to the server.| |[DocumentLibraryVersionCollection](/javascript/api/word/word.documentlibraryversioncollection)|[getItem(index: number)](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-getitem-member(1))|Gets a `DocumentLibraryVersion` object by its index in the collection.| ||[isVersioningEnabled()](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-isversioningenabled-member(1))|Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website.| ||[items](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentMergeOptions](/javascript/api/word/word.documentmergeoptions)|[addToRecentFiles](/javascript/api/word/word.documentmergeoptions#word-word-documentmergeoptions-addtorecentfiles-member)|If provided, specifies whether to add the merged document to recent files.| +||[detectFormatChanges](/javascript/api/word/word.documentmergeoptions#word-word-documentmergeoptions-detectformatchanges-member)|If provided, specifies whether to detect format changes during the merge.| +||[mergeTarget](/javascript/api/word/word.documentmergeoptions#word-word-documentmergeoptions-mergetarget-member)|If provided, specifies the target of the merge operation.| +||[useFormattingFrom](/javascript/api/word/word.documentmergeoptions#word-word-documentmergeoptions-useformattingfrom-member)|If provided, specifies the source of formatting to use in the merge.| +|[DocumentPrintOutOptions](/javascript/api/word/word.documentprintoutoptions)|[activePrinterMacGX](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-activeprintermacgx-member)|If provided, specifies the printer name.| +||[append](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-append-member)|If provided, specifies whether to append to an existing file.| +||[background](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-background-member)|If provided, specifies whether to print in the background.| +||[collate](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-collate-member)|If provided, specifies whether to collate pages.| +||[copies](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-copies-member)|If provided, specifies the number of copies to print.| +||[from](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-from-member)|If provided, specifies the starting page number.| +||[item](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-item-member)|If provided, specifies the item to print.| +||[manualDuplexPrint](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-manualduplexprint-member)|If provided, specifies whether to manually duplex print.| +||[outputFileName](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-outputfilename-member)|If provided, specifies the name of the output file.| +||[pageType](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-pagetype-member)|If provided, specifies the page order.| +||[pages](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-pages-member)|If provided, specifies specific pages to print.| +||[printToFile](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-printtofile-member)|If provided, specifies whether to print to file.| +||[printZoomColumn](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-printzoomcolumn-member)|If provided, specifies the zoom column setting.| +||[printZoomPaperHeight](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-printzoompaperheight-member)|If provided, specifies the paper height for printing in twips (20 twips = 1 point; 72 points = 1 inch).| +||[printZoomPaperWidth](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-printzoompaperwidth-member)|If provided, specifies the paper width for printing in twips (20 twips = 1 point; 72 points = 1 inch).| +||[printZoomRow](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-printzoomrow-member)|If provided, specifies the zoom row setting.| +||[range](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-range-member)|If provided, specifies the range to print.| +||[to](/javascript/api/word/word.documentprintoutoptions#word-word-documentprintoutoptions-to-member)|If provided, specifies the ending page number.| +|[DocumentProtectOptions](/javascript/api/word/word.documentprotectoptions)|[enforceStyleLock](/javascript/api/word/word.documentprotectoptions#word-word-documentprotectoptions-enforcestylelock-member)|If provided, specifies whether to enforce style lock restrictions.| +||[noReset](/javascript/api/word/word.documentprotectoptions#word-word-documentprotectoptions-noreset-member)|If provided, specifies whether to reset form fields when protecting the document.| +||[password](/javascript/api/word/word.documentprotectoptions#word-word-documentprotectoptions-password-member)|If provided, specifies the password to apply for document protection.| +||[useInformationRightsManagement](/javascript/api/word/word.documentprotectoptions#word-word-documentprotectoptions-useinformationrightsmanagement-member)|If provided, specifies whether to use Information Rights Management (IRM).| +|[DocumentRangeOptions](/javascript/api/word/word.documentrangeoptions)|[end](/javascript/api/word/word.documentrangeoptions#word-word-documentrangeoptions-end-member)|If provided, specifies the ending character position.| +||[start](/javascript/api/word/word.documentrangeoptions#word-word-documentrangeoptions-start-member)|If provided, specifies the starting character position.| +|[DocumentReplyWithChangesOptions](/javascript/api/word/word.documentreplywithchangesoptions)|[includeAttachment](/javascript/api/word/word.documentreplywithchangesoptions#word-word-documentreplywithchangesoptions-includeattachment-member)|If provided, specifies whether to include the document as an attachment.| +||[recipients](/javascript/api/word/word.documentreplywithchangesoptions#word-word-documentreplywithchangesoptions-recipients-member)|If provided, specifies the recipients of the reply.| +||[showMessage](/javascript/api/word/word.documentreplywithchangesoptions#word-word-documentreplywithchangesoptions-showmessage-member)|If provided, specifies whether to show the message before sending.| +||[subject](/javascript/api/word/word.documentreplywithchangesoptions#word-word-documentreplywithchangesoptions-subject-member)|If provided, specifies the subject of the reply email.| +|[DocumentSendFaxOverInternetOptions](/javascript/api/word/word.documentsendfaxoverinternetoptions)|[recipients](/javascript/api/word/word.documentsendfaxoverinternetoptions#word-word-documentsendfaxoverinternetoptions-recipients-member)|If provided, specifies the recipients of the fax.| +||[showMessage](/javascript/api/word/word.documentsendfaxoverinternetoptions#word-word-documentsendfaxoverinternetoptions-showmessage-member)|If provided, specifies whether to show the message before sending.| +||[subject](/javascript/api/word/word.documentsendfaxoverinternetoptions#word-word-documentsendfaxoverinternetoptions-subject-member)|If provided, specifies the subject of the fax.| +|[DocumentSendForReviewOptions](/javascript/api/word/word.documentsendforreviewoptions)|[includeAttachment](/javascript/api/word/word.documentsendforreviewoptions#word-word-documentsendforreviewoptions-includeattachment-member)|If provided, specifies whether to include the document as an attachment.| +||[recipients](/javascript/api/word/word.documentsendforreviewoptions#word-word-documentsendforreviewoptions-recipients-member)|If provided, specifies the recipients of the review request.| +||[showMessage](/javascript/api/word/word.documentsendforreviewoptions#word-word-documentsendforreviewoptions-showmessage-member)|If provided, specifies whether to show the message before sending.| +||[subject](/javascript/api/word/word.documentsendforreviewoptions#word-word-documentsendforreviewoptions-subject-member)|If provided, specifies the subject of the review email.| |[DropCap](/javascript/api/word/word.dropcap)|[clear()](/javascript/api/word/word.dropcap#word-word-dropcap-clear-member(1))|Removes the dropped capital letter formatting.| ||[distanceFromText](/javascript/api/word/word.dropcap#word-word-dropcap-distancefromtext-member)|Gets the distance (in points) between the dropped capital letter and the paragraph text.| ||[enable()](/javascript/api/word/word.dropcap#word-word-dropcap-enable-member(1))|Formats the first character in the specified paragraph as a dropped capital letter.| @@ -418,6 +718,10 @@ |[GlowFormat](/javascript/api/word/word.glowformat)|[color](/javascript/api/word/word.glowformat#word-word-glowformat-color-member)|Returns a `ColorFormat` object that represents the color for a glow effect.| ||[radius](/javascript/api/word/word.glowformat#word-word-glowformat-radius-member)|Specifies the length of the radius for a glow effect.| ||[transparency](/javascript/api/word/word.glowformat#word-word-glowformat-transparency-member)|Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear).| +|[GoToOptions](/javascript/api/word/word.gotooptions)|[count](/javascript/api/word/word.gotooptions#word-word-gotooptions-count-member)|If provided, specifies the number of the item in the document.| +||[direction](/javascript/api/word/word.gotooptions#word-word-gotooptions-direction-member)|If provided, specifies the direction the range or selection is moved to.| +||[item](/javascript/api/word/word.gotooptions#word-word-gotooptions-item-member)|If provided, specifies the kind of item the range or selection is moved to.| +||[name](/javascript/api/word/word.gotooptions#word-word-gotooptions-name-member)|If provided, specifies the name if the `item` property is set to Word.GoToItem type `bookmark`, `comment`, `field`, or `object`.| |[GroupContentControl](/javascript/api/word/word.groupcontentcontrol)|[appearance](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-appearance-member)|Specifies the appearance of the content control.| ||[color](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| ||[copy()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| @@ -441,6 +745,16 @@ ||[name](/javascript/api/word/word.headingstyle#word-word-headingstyle-name-member)|Specifies the name of style for a heading.| |[HeadingStyleCollection](/javascript/api/word/word.headingstylecollection)|[add(name: string, level: number)](/javascript/api/word/word.headingstylecollection#word-word-headingstylecollection-add-member(1))|Adds a new heading style to a document.| ||[items](/javascript/api/word/word.headingstylecollection#word-word-headingstylecollection-items-member)|Gets the loaded child items in this collection.| +|[HtmlDivision](/javascript/api/word/word.htmldivision)|[delete()](/javascript/api/word/word.htmldivision#word-word-htmldivision-delete-member(1))|Deletes this HTML division.| +||[htmlDivisionParent(levelsUp?: number)](/javascript/api/word/word.htmldivision#word-word-htmldivision-htmldivisionparent-member(1))|Returns an `HtmlDivision` object that represents a parent division of the current HTML division.| +||[htmlDivisions](/javascript/api/word/word.htmldivision#word-word-htmldivision-htmldivisions-member)|| +||[leftIndent](/javascript/api/word/word.htmldivision#word-word-htmldivision-leftindent-member)|Specifies the left indent value (in points) for this HTML division.| +||[range](/javascript/api/word/word.htmldivision#word-word-htmldivision-range-member)|Gets a `Range` object that represents the portion of a document that's contained in this HTML division.| +||[rightIndent](/javascript/api/word/word.htmldivision#word-word-htmldivision-rightindent-member)|Specifies the right indent (in points) for this HTML division.| +||[spaceAfter](/javascript/api/word/word.htmldivision#word-word-htmldivision-spaceafter-member)|Specifies the amount of spacing (in points) after this HTML division.| +||[spaceBefore](/javascript/api/word/word.htmldivision#word-word-htmldivision-spacebefore-member)|Specifies the spacing (in points) before this HTML division.| +|[HtmlDivisionCollection](/javascript/api/word/word.htmldivisioncollection)|[getItemAt(index: number)](/javascript/api/word/word.htmldivisioncollection#word-word-htmldivisioncollection-getitemat-member(1))|Returns an `HtmlDivision` object from the collection based on the specified index.| +||[items](/javascript/api/word/word.htmldivisioncollection#word-word-htmldivisioncollection-items-member)|Gets the loaded child items in this collection.| |[Hyperlink](/javascript/api/word/word.hyperlink)|[addToFavorites()](/javascript/api/word/word.hyperlink#word-word-hyperlink-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| ||[address](/javascript/api/word/word.hyperlink#word-word-hyperlink-address-member)|Specifies the address (for example, a file name or URL) of the hyperlink.| ||[createNewDocument(fileName: string, editNow: boolean, overwrite: boolean)](/javascript/api/word/word.hyperlink#word-word-hyperlink-createnewdocument-member(1))|Creates a new document linked to the hyperlink.| @@ -574,7 +888,7 @@ ||[isFormattingPreservedOnUpdate](/javascript/api/word/word.oleformat#word-word-oleformat-isformattingpreservedonupdate-member)|Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.| ||[label](/javascript/api/word/word.oleformat#word-word-oleformat-label-member)|Gets a string that's used to identify the portion of the source file that's being linked.| ||[open()](/javascript/api/word/word.oleformat#word-word-oleformat-open-member(1))|Opens the `OleFormat` object.| -||[progID](/javascript/api/word/word.oleformat#word-word-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| +||[progId](/javascript/api/word/word.oleformat#word-word-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| |[Page](/javascript/api/word/word.page)|[breaks](/javascript/api/word/word.page#word-word-page-breaks-member)|Gets a `BreakCollection` object that represents the breaks on the page.| |[PageSetup](/javascript/api/word/word.pagesetup)|[bookFoldPrinting](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprinting-member)|Specifies whether Microsoft Word prints the document as a booklet.| ||[bookFoldPrintingSheets](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprintingsheets-member)|Specifies the number of pages for each booklet.| @@ -722,6 +1036,10 @@ ||[underline](/javascript/api/word/word.range#word-word-range-underline-member)|Specifies the type of underline applied to the range.| |[RangeScopedCollection](/javascript/api/word/word.rangescopedcollection)|[getItem(index: number)](/javascript/api/word/word.rangescopedcollection#word-word-rangescopedcollection-getitem-member(1))|Gets a `Range` object by its index in the collection.| ||[items](/javascript/api/word/word.rangescopedcollection#word-word-rangescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[ReadabilityStatistic](/javascript/api/word/word.readabilitystatistic)|[name](/javascript/api/word/word.readabilitystatistic#word-word-readabilitystatistic-name-member)|Returns the name of the readability statistic.| +||[value](/javascript/api/word/word.readabilitystatistic#word-word-readabilitystatistic-value-member)|Returns the value of the grammar statistic.| +|[ReadabilityStatisticCollection](/javascript/api/word/word.readabilitystatisticcollection)|[getItemAt(index: number)](/javascript/api/word/word.readabilitystatisticcollection#word-word-readabilitystatisticcollection-getitemat-member(1))|Gets the readability statistic at the specified index.| +||[items](/javascript/api/word/word.readabilitystatisticcollection#word-word-readabilitystatisticcollection-items-member)|Gets the loaded child items in this collection.| |[ReflectionFormat](/javascript/api/word/word.reflectionformat)|[blur](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-blur-member)|Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0.| ||[offset](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-offset-member)|Specifies the amount of separation, in points, of the reflected image from the shape.| ||[size](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-size-member)|Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100.| @@ -775,6 +1093,10 @@ |[Section](/javascript/api/word/word.section)|[borders](/javascript/api/word/word.section#word-word-section-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders in the section.| ||[pageSetup](/javascript/api/word/word.section#word-word-section-pagesetup-member)|Returns a `PageSetup` object that's associated with the section.| ||[protectedForForms](/javascript/api/word/word.section#word-word-section-protectedforforms-member)|Specifies if the section is protected for forms.| +|[SelectNodesOptions](/javascript/api/word/word.selectnodesoptions)|[fastSearchSkippingTextNodes](/javascript/api/word/word.selectnodesoptions#word-word-selectnodesoptions-fastsearchskippingtextnodes-member)|If provided, specifies whether to skip text nodes in the search.| +||[prefixMapping](/javascript/api/word/word.selectnodesoptions#word-word-selectnodesoptions-prefixmapping-member)|If provided, specifies the prefix mapping for the XPath expression.| +|[SelectSingleNodeOptions](/javascript/api/word/word.selectsinglenodeoptions)|[fastSearchSkippingTextNodes](/javascript/api/word/word.selectsinglenodeoptions#word-word-selectsinglenodeoptions-fastsearchskippingtextnodes-member)|If provided, specifies whether to skip text nodes in the search.| +||[prefixMapping](/javascript/api/word/word.selectsinglenodeoptions#word-word-selectsinglenodeoptions-prefixmapping-member)|If provided, specifies the prefix mapping for the XPath expression.| |[Selection](/javascript/api/word/word.selection)|[borders](/javascript/api/word/word.selection#word-word-selection-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection.| ||[calculate()](/javascript/api/word/word.selection#word-word-selection-calculate-member(1))|Calculates the first mathematical expression within the selection.| ||[cancelMode()](/javascript/api/word/word.selection#word-word-selection-cancelmode-member(1))|Cancels a mode such as extend or column select.| @@ -1221,7 +1543,6 @@ ||[getFlowDirection()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getflowdirection-member(1))|Gets the direction in which text flows from one text column to the next.| ||[getHasLineBetween()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-gethaslinebetween-member(1))|Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| ||[getIsEvenlySpaced()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getisevenlyspaced-member(1))|Gets whether text columns are evenly spaced.| -||[getItem(index: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getitem-member(1))|Gets a `TextColumn` by its index in the collection.| ||[items](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-items-member)|Gets the loaded child items in this collection.| ||[setCount(numColumns: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setcount-member(1))|Arranges text into the specified number of text columns.| ||[setFlowDirection(value: Word.FlowDirection)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setflowdirection-member(1))|Sets the direction in which text flows from one text column to the next.| @@ -1323,6 +1644,17 @@ ||[showHeading(level: number)](/javascript/api/word/word.view#word-word-view-showheading-member(1))|Shows all headings up to the specified heading level and hides subordinate headings and body text.| ||[splitSpecial](/javascript/api/word/word.view#word-word-view-splitspecial-member)|Specifies the active window pane.| ||[type](/javascript/api/word/word.view#word-word-view-type-member)|Specifies the view type.| +|[WebSettings](/javascript/api/word/word.websettings)|[allowPng](/javascript/api/word/word.websettings#word-word-websettings-allowpng-member)|Specifies whether PNG is allowed as an image format when saving a document as a webpage.| +||[encoding](/javascript/api/word/word.websettings#word-word-websettings-encoding-member)|Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document.| +||[folderSuffix](/javascript/api/word/word.websettings#word-word-websettings-foldersuffix-member)|Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder.| +||[organizeInFolder](/javascript/api/word/word.websettings#word-word-websettings-organizeinfolder-member)|Specifies whether supporting files are organized in a separate folder when saving the document as a webpage.| +||[pixelsPerInch](/javascript/api/word/word.websettings#word-word-websettings-pixelsperinch-member)|Specifies the density (pixels per inch) of graphics images and table cells on a webpage.| +||[relyOnCSS](/javascript/api/word/word.websettings#word-word-websettings-relyoncss-member)|Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser.| +||[relyOnVectorMarkupLanguage](/javascript/api/word/word.websettings#word-word-websettings-relyonvectormarkuplanguage-member)|Specifies whether image files are not generated from drawing objects when saving a document as a webpage.| +||[screenSize](/javascript/api/word/word.websettings#word-word-websettings-screensize-member)|Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser.| +||[targetBrowser](/javascript/api/word/word.websettings#word-word-websettings-targetbrowser-member)|Specifies the target browser for documents viewed in a web browser.| +||[useDefaultFolderSuffix()](/javascript/api/word/word.websettings#word-word-websettings-usedefaultfoldersuffix-member(1))|Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed.| +||[useLongFileNames](/javascript/api/word/word.websettings#word-word-websettings-uselongfilenames-member)|Specifies whether long file names are used when saving the document as a webpage.| |[Window](/javascript/api/word/word.window)|[activate()](/javascript/api/word/word.window#word-word-window-activate-member(1))|Activates the window.| ||[areRulersDisplayed](/javascript/api/word/word.window#word-word-window-arerulersdisplayed-member)|Specifies whether rulers are displayed for the window or pane.| ||[areScreenTipsDisplayed](/javascript/api/word/word.window#word-word-window-arescreentipsdisplayed-member)|Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.| @@ -1380,5 +1712,37 @@ ||[setMapping(xPath: string, options?: Word.XmlSetMappingOptions)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmapping-member(1))|Allows creating or changing the XML mapping on the content control.| ||[setMappingByNode(node: Word.CustomXmlNode)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmappingbynode-member(1))|Allows creating or changing the XML data mapping on the content control.| ||[xpath](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-xpath-member)|Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node.| +|[XmlNode](/javascript/api/word/word.xmlnode)|[attributes](/javascript/api/word/word.xmlnode#word-word-xmlnode-attributes-member)|Gets the attributes for this XML node.| +||[baseName](/javascript/api/word/word.xmlnode#word-word-xmlnode-basename-member)|Gets the name of the element without any prefix.| +||[childNodes](/javascript/api/word/word.xmlnode#word-word-xmlnode-childnodes-member)|Gets the child elements of this XML node.| +||[copy()](/javascript/api/word/word.xmlnode#word-word-xmlnode-copy-member(1))|Copies this XML node, excluding XML markup, to the Clipboard.| +||[cut()](/javascript/api/word/word.xmlnode#word-word-xmlnode-cut-member(1))|Removes this XML node from the document and places it on the Clipboard.| +||[delete()](/javascript/api/word/word.xmlnode#word-word-xmlnode-delete-member(1))|Deletes the XML node from the XML document.| +||[firstChild](/javascript/api/word/word.xmlnode#word-word-xmlnode-firstchild-member)|Gets the first child node if this is a parent node.| +||[hasChildNodes](/javascript/api/word/word.xmlnode#word-word-xmlnode-haschildnodes-member)|Gets whether this XML node has child nodes.| +||[lastChild](/javascript/api/word/word.xmlnode#word-word-xmlnode-lastchild-member)|Gets the last child node if this is a parent node.| +||[level](/javascript/api/word/word.xmlnode#word-word-xmlnode-level-member)|Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row.| +||[namespaceUri](/javascript/api/word/word.xmlnode#word-word-xmlnode-namespaceuri-member)|Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node.| +||[nextSibling](/javascript/api/word/word.xmlnode#word-word-xmlnode-nextsibling-member)|Gets the next element in the document that's at the same level as this XML node.| +||[nodeType](/javascript/api/word/word.xmlnode#word-word-xmlnode-nodetype-member)|Gets the type of node.| +||[nodeValue](/javascript/api/word/word.xmlnode#word-word-xmlnode-nodevalue-member)|Specifies the value of this XML node.| +||[ownerDocument](/javascript/api/word/word.xmlnode#word-word-xmlnode-ownerdocument-member)|Gets the parent document of this XML node.| +||[parentNode](/javascript/api/word/word.xmlnode#word-word-xmlnode-parentnode-member)|Gets the parent element of this XML node.| +||[placeholderText](/javascript/api/word/word.xmlnode#word-word-xmlnode-placeholdertext-member)|Specifies the text displayed for this element if it contains no text.| +||[previousSibling](/javascript/api/word/word.xmlnode#word-word-xmlnode-previoussibling-member)|Gets the previous element in the document that's at the same level as this XML node.| +||[range](/javascript/api/word/word.xmlnode#word-word-xmlnode-range-member)|Gets the portion of a document that is contained in this XML node.| +||[removeChild(childElement: Word.XmlNode)](/javascript/api/word/word.xmlnode#word-word-xmlnode-removechild-member(1))|Removes a child element from this XML node.| +||[selectNodes(xPath: string, options?: Word.SelectNodesOptions)](/javascript/api/word/word.xmlnode#word-word-xmlnode-selectnodes-member(1))|Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node.| +||[selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions)](/javascript/api/word/word.xmlnode#word-word-xmlnode-selectsinglenode-member(1))|Returns the first child element that matches the XPath parameter within this XML node.| +||[setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions)](/javascript/api/word/word.xmlnode#word-word-xmlnode-setvalidationerror-member(1))|Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid.| +||[text](/javascript/api/word/word.xmlnode#word-word-xmlnode-text-member)|Specifies the text contained within the XML element.| +||[validate()](/javascript/api/word/word.xmlnode#word-word-xmlnode-validate-member(1))|Validates this XML node against the XML schemas that are attached to the document.| +||[validationErrorText](/javascript/api/word/word.xmlnode#word-word-xmlnode-validationerrortext-member)|Gets the description for a validation error on this `XmlNode` object.| +||[validationStatus](/javascript/api/word/word.xmlnode#word-word-xmlnode-validationstatus-member)|Gets whether this element is valid according to the attached schema.| +|[XmlNodeCollection](/javascript/api/word/word.xmlnodecollection)|[getItem(index: number)](/javascript/api/word/word.xmlnodecollection#word-word-xmlnodecollection-getitem-member(1))|Gets a `XmlNode` object by its index in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.xmlnodecollection#word-word-xmlnodecollection-getitemat-member(1))|Returns an individual `XmlNode` object in a collection.| +||[items](/javascript/api/word/word.xmlnodecollection#word-word-xmlnodecollection-items-member)|Gets the loaded child items in this collection.| +|[XmlNodeSetValidationErrorOptions](/javascript/api/word/word.xmlnodesetvalidationerroroptions)|[clearedAutomatically](/javascript/api/word/word.xmlnodesetvalidationerroroptions#word-word-xmlnodesetvalidationerroroptions-clearedautomatically-member)|If provided, specifies whether the validation error should be cleared automatically.| +||[errorText](/javascript/api/word/word.xmlnodesetvalidationerroroptions#word-word-xmlnodesetvalidationerroroptions-errortext-member)|If provided, specifies the error text to display for the validation error.| |[XmlSetMappingOptions](/javascript/api/word/word.xmlsetmappingoptions)|[prefixMapping](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-prefixmapping-member)|If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method.| ||[source](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-source-member)|If provided, specifies the desired custom XML data to map the content control to.| diff --git a/docs/requirement-sets/word/word-preview-apis.md b/docs/requirement-sets/word/word-preview-apis.md index 2a482d940d..8f5efbd77b 100644 --- a/docs/requirement-sets/word/word-preview-apis.md +++ b/docs/requirement-sets/word/word-preview-apis.md @@ -1,7 +1,7 @@ --- title: Word JavaScript preview APIs description: Details about upcoming Word JavaScript APIs. -ms.date: 09/18/2025 +ms.date: 09/26/2025 ms.topic: whats-new ms.localizationpriority: medium --- diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 83c7824ae8..4f064b2932 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -11738,6 +11738,9 @@ Word.Application,"retrieveStylesFromBase64(base64File)",Method,Good,true Word.Application,"set(properties, options)",Method,Good,false Word.Application,"set(properties)",Method,Good,false Word.Application,"toJSON()",Method,Excellent,false +Word.ApplyQuickStyleSet,N/A,Enum,Unknown,false +Word.ApplyQuickStyleSet,"sessionStart",EnumField,Good,false +Word.ApplyQuickStyleSet,"template",EnumField,Good,false Word.ArrowheadLength,N/A,Enum,Unknown,false Word.ArrowheadLength,"long",EnumField,Fine,false Word.ArrowheadLength,"medium",EnumField,Fine,false @@ -11760,6 +11763,13 @@ Word.AutoFitBehavior,N/A,Enum,Unknown,false Word.AutoFitBehavior,"content",EnumField,Fine,false Word.AutoFitBehavior,"fixedSize",EnumField,Fine,false Word.AutoFitBehavior,"window",EnumField,Fine,false +Word.AutoMacro,N/A,Enum,Unknown,false +Word.AutoMacro,"close",EnumField,Good,false +Word.AutoMacro,"exit",EnumField,Good,false +Word.AutoMacro,"new",EnumField,Good,false +Word.AutoMacro,"open",EnumField,Good,false +Word.AutoMacro,"startWord",EnumField,Good,false +Word.AutoMacro,"sync",EnumField,Good,false Word.BaselineAlignment,N/A,Enum,Unknown,false Word.BaselineAlignment,"auto",EnumField,Fine,false Word.BaselineAlignment,"baseline",EnumField,Fine,false @@ -12427,6 +12437,10 @@ Word.CheckboxContentControl,"set(properties)",Method,Good,false Word.CheckboxContentControl,"toJSON()",Method,Excellent,false Word.CheckboxContentControl,"track()",Method,Excellent,false Word.CheckboxContentControl,"untrack()",Method,Excellent,false +Word.CheckInVersionType,N/A,Enum,Unknown,false +Word.CheckInVersionType,"major",EnumField,Fine,false +Word.CheckInVersionType,"minor",EnumField,Fine,false +Word.CheckInVersionType,"overwrite",EnumField,Fine,false Word.CloseBehavior,N/A,Enum,Unknown,true Word.CloseBehavior,"save",EnumField,Fine,false Word.CloseBehavior,"skipSave",EnumField,Good,false @@ -12676,6 +12690,12 @@ Word.CompareTarget,N/A,Enum,Unknown,true Word.CompareTarget,"compareTargetCurrent",EnumField,Good,false Word.CompareTarget,"compareTargetNew",EnumField,Good,false Word.CompareTarget,"compareTargetSelected",EnumField,Good,false +Word.CompatibilityMode,N/A,Enum,Unknown,false +Word.CompatibilityMode,"current",EnumField,Fine,false +Word.CompatibilityMode,"word2003",EnumField,Fine,false +Word.CompatibilityMode,"word2007",EnumField,Fine,false +Word.CompatibilityMode,"word2010",EnumField,Fine,false +Word.CompatibilityMode,"word2013",EnumField,Fine,false Word.ConditionalStyle,N/A,Class,Unknown,false Word.ConditionalStyle,"borders",Property,Excellent,false Word.ConditionalStyle,"bottomPadding",Property,Great,false @@ -13256,70 +13276,291 @@ Word.DocPartInsertType,"content",EnumField,Fine,false Word.DocPartInsertType,"page",EnumField,Fine,false Word.DocPartInsertType,"paragraph",EnumField,Fine,false Word.Document,N/A,Class,Missing,true +Word.Document,"activeTheme",Property,Good,false +Word.Document,"activeThemeDisplayName",Property,Poor,false Word.Document,"activeWindow",Property,Poor,true +Word.Document,"areFilePropertiesPasswordEncrypted",Property,Fine,false +Word.Document,"areGrammaticalErrorsShown",Property,Excellent,false +Word.Document,"areMathDefaultsUsed",Property,Excellent,false +Word.Document,"areNewerFeaturesDisabled",Property,Great,false +Word.Document,"areSpellingErrorsShown",Property,Excellent,false +Word.Document,"areStylesUpdatedOnOpen",Property,Great,false +Word.Document,"areTrueTypeFontsEmbedded",Property,Excellent,false Word.Document,"attachedTemplate",Property,Excellent,false Word.Document,"autoHyphenation",Property,Great,false Word.Document,"autoSaveOn",Property,Great,false +Word.Document,"background",Property,Good,false Word.Document,"bibliography",Property,Excellent,false Word.Document,"body",Property,Good,false Word.Document,"bookmarks",Property,Great,false +Word.Document,"builtInDocumentProperties",Property,Good,false Word.Document,"changeTrackingMode",Property,Good,true +Word.Document,"characters",Property,Great,false Word.Document,"coauthoring",Property,Good,false +Word.Document,"codeName",Property,Poor,false +Word.Document,"comments",Property,Good,false +Word.Document,"compatibilityMode",Property,Good,false Word.Document,"consecutiveHyphensLimit",Property,Great,false +Word.Document,"content",Property,Good,false Word.Document,"contentControls",Property,Good,false Word.Document,"context",Property,Excellent,false +Word.Document,"currentRsid",Property,Fine,false +Word.Document,"customDocumentProperties",Property,Fine,false Word.Document,"customXmlParts",Property,Poor,false +Word.Document,"defaultTabStop",Property,Excellent,false +Word.Document,"defaultTargetFrame",Property,Great,false Word.Document,"documentLibraryVersions",Property,Excellent,false +Word.Document,"doNotEmbedSystemFonts",Property,Great,false +Word.Document,"encryptionProvider",Property,Excellent,false +Word.Document,"farEastLineBreakLanguage",Property,Excellent,false +Word.Document,"farEastLineBreakLevel",Property,Good,false +Word.Document,"fields",Property,Great,false +Word.Document,"formattingIsNextLevelShown",Property,Excellent,false +Word.Document,"formattingIsUserStyleNameShown",Property,Good,false Word.Document,"frames",Property,Great,false +Word.Document,"fullName",Property,Poor,false +Word.Document,"grammaticalErrors",Property,Good,false +Word.Document,"gridDistanceHorizontal",Property,Excellent,false +Word.Document,"gridDistanceVertical",Property,Excellent,false +Word.Document,"gridIsOriginFromMargin",Property,Great,false +Word.Document,"gridOriginHorizontal",Property,Great,false +Word.Document,"gridOriginVertical",Property,Great,false +Word.Document,"gridSpaceBetweenHorizontalLines",Property,Great,false +Word.Document,"gridSpaceBetweenVerticalLines",Property,Great,false +Word.Document,"hasPassword",Property,Good,false +Word.Document,"hasVbProject",Property,Good,false Word.Document,"hyperlinks",Property,Great,false Word.Document,"hyphenateCaps",Property,Great,false +Word.Document,"hyphenationZone",Property,Great,false Word.Document,"indexes",Property,Great,false +Word.Document,"isAutoFormatOverrideOn",Property,Excellent,false +Word.Document,"isChartDataPointTracked",Property,Great,false +Word.Document,"isCompatible",Property,Excellent,false +Word.Document,"isFinal",Property,Good,false +Word.Document,"isFontsSubsetSaved",Property,Great,false +Word.Document,"isFormsDataPrinted",Property,Great,false +Word.Document,"isFormsDataSaved",Property,Great,false +Word.Document,"isGrammarChecked",Property,Great,false +Word.Document,"isInAutoSave",Property,Good,false +Word.Document,"isInFormsDesign",Property,Poor,false +Word.Document,"isKerningByAlgorithm",Property,Great,false +Word.Document,"isLinguisticDataEmbedded",Property,Great,false +Word.Document,"isMasterDocument",Property,Poor,false +Word.Document,"isOptimizedForWord97",Property,Great,false +Word.Document,"isPostScriptPrintedOverText",Property,Excellent,false +Word.Document,"isQuickStyleSetLocked",Property,Great,false +Word.Document,"isReadOnly",Property,Fine,false +Word.Document,"isReadOnlyRecommended",Property,Excellent,false +Word.Document,"isSnappedToGrid",Property,Great,false +Word.Document,"isSnappedToShapes",Property,Great,false +Word.Document,"isSpellingChecked",Property,Great,false +Word.Document,"isStyleEnforced",Property,Great,false +Word.Document,"isSubdocument",Property,Fine,false +Word.Document,"isThemeLocked",Property,Great,false +Word.Document,"isUserControl",Property,Great,false +Word.Document,"isVbaSigned",Property,Poor,false +Word.Document,"isWriteReserved",Property,Fine,false +Word.Document,"justificationMode",Property,Good,false +Word.Document,"kind",Property,Excellent,false Word.Document,"languageDetected",Property,Great,false +Word.Document,"listParagraphs",Property,Good,false +Word.Document,"lists",Property,Good,false Word.Document,"listTemplates",Property,Great,false +Word.Document,"noLineBreakAfter",Property,Great,false +Word.Document,"noLineBreakBefore",Property,Great,false +Word.Document,"openEncoding",Property,Fine,false +Word.Document,"originalDocumentTitle",Property,Fine,false Word.Document,"pageSetup",Property,Great,false +Word.Document,"paragraphs",Property,Good,false +Word.Document,"password",Property,Fine,false +Word.Document,"passwordEncryptionAlgorithm",Property,Fine,false +Word.Document,"passwordEncryptionKeyLength",Property,Fine,false +Word.Document,"passwordEncryptionProvider",Property,Poor,false +Word.Document,"path",Property,Fine,false +Word.Document,"printRevisions",Property,Great,false Word.Document,"properties",Property,Poor,true +Word.Document,"protectionType",Property,Poor,false +Word.Document,"readabilityStatistics",Property,Good,false +Word.Document,"readingLayoutSizeX",Property,Excellent,false +Word.Document,"readingLayoutSizeY",Property,Excellent,false +Word.Document,"readingModeIsLayoutFrozen",Property,Great,false +Word.Document,"removePersonalInformationOnSave",Property,Great,false +Word.Document,"revisedDocumentTitle",Property,Fine,false Word.Document,"revisions",Property,Fine,false Word.Document,"saved",Property,Good,false +Word.Document,"saveEncoding",Property,Excellent,false +Word.Document,"saveFormat",Property,Poor,false Word.Document,"sections",Property,Good,false Word.Document,"selection",Property,Great,false +Word.Document,"sentences",Property,Great,false Word.Document,"settings",Property,Poor,true +Word.Document,"spellingErrors",Property,Excellent,false +Word.Document,"storyRanges",Property,Good,false +Word.Document,"styles",Property,Poor,false Word.Document,"tableOfAuthoritiesCategories",Property,Great,false +Word.Document,"tables",Property,Good,false Word.Document,"tablesOfAuthorities",Property,Great,false Word.Document,"tablesOfContents",Property,Great,false Word.Document,"tablesOfFigures",Property,Great,false +Word.Document,"textEncoding",Property,Good,false +Word.Document,"textLineEnding",Property,Great,false +Word.Document,"trackedChangesAreDateAndTimeRemoved",Property,Great,false +Word.Document,"trackFormatting",Property,Excellent,false +Word.Document,"trackMoves",Property,Excellent,false +Word.Document,"trackRevisions",Property,Great,false +Word.Document,"type",Property,Poor,false +Word.Document,"webSettings",Property,Great,false Word.Document,"windows",Property,Good,false +Word.Document,"words",Property,Great,false +Word.Document,"writePassword",Property,Fine,false +Word.Document,"xmlAreAdvancedErrorsShown",Property,Excellent,false +Word.Document,"xmlIsXsltUsedWhenSaving",Property,Great,false +Word.Document,"xmlSaveThroughXSLT",Property,Excellent,false +Word.Document,"acceptAllRevisions()",Method,Poor,false +Word.Document,"acceptAllRevisionsShown()",Method,Fine,false +Word.Document,"activate()",Method,Fine,false Word.Document,"addStyle(name, type)",Method,Poor,true Word.Document,"addStyle(name, type)",Method,Poor,false +Word.Document,"addToFavorites()",Method,Good,false +Word.Document,"applyQuickStyleSet(style)",Method,Good,false +Word.Document,"applyQuickStyleSet(style)",Method,Good,false +Word.Document,"applyTheme(name)",Method,Fine,false +Word.Document,"autoFormat()",Method,Poor,false +Word.Document,"canCheckin()",Method,Great,false +Word.Document,"checkConsistencyJapanese()",Method,Good,false +Word.Document,"checkGrammar()",Method,Fine,false +Word.Document,"checkIn(options)",Method,Good,false +Word.Document,"checkInWithVersion(options)",Method,Good,false +Word.Document,"checkSpelling(options)",Method,Poor,false Word.Document,"close(closeBehavior)",Method,Fine,true Word.Document,"close(closeBehavior)",Method,Fine,false +Word.Document,"closePrintPreview()",Method,Fine,false Word.Document,"compare(filePath, documentCompareOptions)",Method,Good,true Word.Document,"compareFromBase64(base64File, documentCompareOptions)",Method,Good,false +Word.Document,"computeStatistics(statistic, includeFootnotesAndEndnotes)",Method,Good,false +Word.Document,"computeStatistics(statistic, includeFootnotesAndEndnotes)",Method,Good,false +Word.Document,"convert()",Method,Fine,false +Word.Document,"convertAutoHyphens()",Method,Poor,false +Word.Document,"convertNumbersToText(numberType)",Method,Good,false +Word.Document,"convertNumbersToText(numberType)",Method,Good,false +Word.Document,"convertVietnameseDocument(codePageOrigin)",Method,Good,false +Word.Document,"copyStylesFromTemplate(StyleTemplate)",Method,Good,false +Word.Document,"countNumberedItems(options)",Method,Great,false +Word.Document,"deleteAllComments()",Method,Fine,false +Word.Document,"deleteAllCommentsShown()",Method,Good,false +Word.Document,"deleteAllInkAnnotations()",Method,Good,false Word.Document,"deleteBookmark(name)",Method,Great,false Word.Document,"detectLanguage()",Method,Fine,false +Word.Document,"endReview(options)",Method,Fine,false +Word.Document,"exportAsFixedFormat(outputFileName, exportFormat, options)",Method,Poor,false +Word.Document,"exportAsFixedFormat(outputFileName, exportFormat, options)",Method,Poor,false +Word.Document,"exportAsFixedFormat2(outputFileName, exportFormat, options)",Method,Poor,false +Word.Document,"exportAsFixedFormat2(outputFileName, exportFormat, options)",Method,Poor,false +Word.Document,"exportAsFixedFormat3(outputFileName, exportFormat, options)",Method,Fine,false +Word.Document,"exportAsFixedFormat3(outputFileName, exportFormat, options)",Method,Fine,false +Word.Document,"fitToPages()",Method,Fine,false +Word.Document,"followHyperlink(options)",Method,Excellent,false +Word.Document,"freezeLayout()",Method,Poor,false Word.Document,"getAnnotationById(id)",Method,Great,false Word.Document,"getBookmarkRange(name)",Method,Great,false Word.Document,"getBookmarkRangeOrNullObject(name)",Method,Excellent,false Word.Document,"getContentControls(options)",Method,Fine,true +Word.Document,"getCrossReferenceItems(referenceType)",Method,Excellent,false +Word.Document,"getCrossReferenceItems(referenceType)",Method,Excellent,false Word.Document,"getEndnoteBody()",Method,Poor,false Word.Document,"getFootnoteBody()",Method,Poor,false Word.Document,"getParagraphByUniqueLocalId(id)",Method,Excellent,true +Word.Document,"getRange(options)",Method,Excellent,false Word.Document,"getSelection()",Method,Fine,true Word.Document,"getStyles()",Method,Good,true +Word.Document,"goTo(options)",Method,Excellent,false Word.Document,"importStylesFromJson(stylesJson, importedStylesConflictBehavior)",Method,Fine,true Word.Document,"importStylesFromJson(stylesJson, importedStylesConflictBehavior)",Method,Fine,false Word.Document,"insertFileFromBase64(base64File, insertLocation, insertFileOptions)",Method,Great,true Word.Document,"load(options)",Method,Excellent,true Word.Document,"load(propertyNames)",Method,Excellent,false Word.Document,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Document,"lockServerFile()",Method,Fine,false +Word.Document,"makeCompatibilityDefault()",Method,Fine,false Word.Document,"manualHyphenation()",Method,Fine,false +Word.Document,"merge(fileName, options)",Method,Fine,false +Word.Document,"post()",Method,Fine,false +Word.Document,"presentIt()",Method,Poor,false +Word.Document,"printOut(options)",Method,Poor,false +Word.Document,"printPreview()",Method,Poor,false +Word.Document,"protect(type, options)",Method,Poor,false +Word.Document,"protect(type, options)",Method,Poor,false +Word.Document,"redo(times)",Method,Good,false +Word.Document,"rejectAllRevisions()",Method,Poor,false +Word.Document,"rejectAllRevisionsShown()",Method,Fine,false +Word.Document,"reload()",Method,Fine,false +Word.Document,"reloadAs(encoding)",Method,Fine,false +Word.Document,"reloadAs(encoding)",Method,Fine,false +Word.Document,"removeDocumentInformation(removeDocInfoType)",Method,Fine,false +Word.Document,"removeDocumentInformation(removeDocInfoType)",Method,Fine,false +Word.Document,"removeLockedStyles()",Method,Good,false +Word.Document,"removeNumbers(numberType)",Method,Poor,false +Word.Document,"removeNumbers(numberType)",Method,Poor,false +Word.Document,"removeTheme()",Method,Fine,false +Word.Document,"repaginate()",Method,Poor,false +Word.Document,"replyWithChanges(options)",Method,Good,false +Word.Document,"resetFormFields()",Method,Good,false +Word.Document,"returnToLastReadPosition()",Method,Good,false +Word.Document,"runAutoMacro(autoMacro)",Method,Good,false +Word.Document,"runAutoMacro(autoMacro)",Method,Good,false Word.Document,"save(saveBehavior, fileName)",Method,Missing,true Word.Document,"save(saveBehavior, fileName)",Method,Missing,false +Word.Document,"saveAsQuickStyleSet(fileName)",Method,Poor,false Word.Document,"search(searchText, searchOptions)",Method,Excellent,false +Word.Document,"select()",Method,Poor,false +Word.Document,"selectContentControlsByTag(tag)",Method,Great,false +Word.Document,"selectContentControlsByTitle(title)",Method,Excellent,false +Word.Document,"selectLinkedControls(node)",Method,Excellent,false +Word.Document,"selectNodes(xPath, options)",Method,Excellent,false +Word.Document,"selectSingleNode(xPath, options)",Method,Excellent,false +Word.Document,"selectUnlinkedControls(stream)",Method,Great,false +Word.Document,"sendFax(address, subject)",Method,Fine,false +Word.Document,"sendFaxOverInternet(options)",Method,Good,false +Word.Document,"sendForReview(options)",Method,Good,false +Word.Document,"sendMail()",Method,Fine,false Word.Document,"set(properties, options)",Method,Good,false Word.Document,"set(properties)",Method,Good,false +Word.Document,"setDefaultTableStyle(style, setInTemplate)",Method,Great,false +Word.Document,"setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)",Method,Good,false +Word.Document,"toggleFormsDesign()",Method,Poor,false Word.Document,"toJSON()",Method,Excellent,false Word.Document,"track()",Method,Excellent,false +Word.Document,"transformDocument(path, dataOnly)",Method,Good,false +Word.Document,"undo(times)",Method,Fine,false +Word.Document,"undoClear()",Method,Fine,false +Word.Document,"unprotect(password)",Method,Poor,false Word.Document,"untrack()",Method,Excellent,false +Word.Document,"updateStyles()",Method,Fine,false +Word.Document,"viewCode()",Method,Fine,false +Word.Document,"viewPropertyBrowser()",Method,Good,false +Word.Document,"webPagePreview()",Method,Good,false +Word.DocumentCheckInOptions,N/A,Interface,Unknown,false +Word.DocumentCheckInOptions,"comment",Property,Great,false +Word.DocumentCheckInOptions,"makePublic",Property,Excellent,false +Word.DocumentCheckInOptions,"saveChanges",Property,Excellent,false +Word.DocumentCheckInWithVersionOptions,N/A,Interface,Unknown,false +Word.DocumentCheckInWithVersionOptions,"comment",Property,Great,false +Word.DocumentCheckInWithVersionOptions,"makePublic",Property,Excellent,false +Word.DocumentCheckInWithVersionOptions,"saveChanges",Property,Excellent,false +Word.DocumentCheckInWithVersionOptions,"versionType",Property,Excellent,false +Word.DocumentCheckSpellingOptions,N/A,Interface,Unknown,false +Word.DocumentCheckSpellingOptions,"alwaysSuggest",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary10",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary2",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary3",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary4",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary5",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary6",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary7",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary8",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"customDictionary9",Property,Excellent,false +Word.DocumentCheckSpellingOptions,"ignoreUppercase",Property,Excellent,false Word.DocumentCompareOptions,N/A,Interface,Unknown,true Word.DocumentCompareOptions,"addToRecentFiles",Property,Excellent,false Word.DocumentCompareOptions,"authorName",Property,Excellent,false @@ -13328,6 +13569,9 @@ Word.DocumentCompareOptions,"detectFormatChanges",Property,Good,false Word.DocumentCompareOptions,"ignoreAllComparisonWarnings",Property,Excellent,false Word.DocumentCompareOptions,"removeDateAndTime",Property,Excellent,false Word.DocumentCompareOptions,"removePersonalInformation",Property,Excellent,false +Word.DocumentCountNumberedItemsOptions,N/A,Interface,Unknown,false +Word.DocumentCountNumberedItemsOptions,"level",Property,Great,false +Word.DocumentCountNumberedItemsOptions,"numberType",Property,Excellent,false Word.DocumentCreated,N/A,Class,Missing,true Word.DocumentCreated,"body",Property,Good,false Word.DocumentCreated,"contentControls",Property,Good,false @@ -13356,6 +13600,206 @@ Word.DocumentCreated,"set(properties)",Method,Good,false Word.DocumentCreated,"toJSON()",Method,Excellent,false Word.DocumentCreated,"track()",Method,Excellent,false Word.DocumentCreated,"untrack()",Method,Excellent,false +Word.DocumentEncoding,N/A,Enum,Unknown,false +Word.DocumentEncoding,"arabic",EnumField,Fine,false +Word.DocumentEncoding,"arabicAsmo",EnumField,Fine,false +Word.DocumentEncoding,"arabicAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"arabicTransparentAsmo",EnumField,Fine,false +Word.DocumentEncoding,"autoDetect",EnumField,Fine,false +Word.DocumentEncoding,"baltic",EnumField,Fine,false +Word.DocumentEncoding,"centralEuropean",EnumField,Fine,false +Word.DocumentEncoding,"cyrillic",EnumField,Fine,false +Word.DocumentEncoding,"cyrillicAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicArabic",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicDenmarkNorway",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicFinlandSweden",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicFrance",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicGermany",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicGreek",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicGreekModern",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicHebrew",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicIcelandic",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicInternational",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicItaly",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicJapaneseKatakanaExtended",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicJapaneseKatakanaExtendedAndJapanese",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicJapaneseLatinExtendedAndJapanese",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicKoreanExtended",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicKoreanExtendedAndKorean",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicLatinAmericaSpain",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicMultilingualRoeceLatin2",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicRussian",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicSerbianBulgarian",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicSimplifiedChineseExtendedAndSimplifiedChinese",EnumField,Good,false +Word.DocumentEncoding,"ebcdicThai",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicTurkish",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicTurkishLatin5",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicUnitedKingdom",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicUsCanada",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicUsCanadaAndJapanese",EnumField,Fine,false +Word.DocumentEncoding,"ebcdicUsCanadaAndTraditionalChinese",EnumField,Fine,false +Word.DocumentEncoding,"eucChineseSimplifiedChinese",EnumField,Good,false +Word.DocumentEncoding,"eucJapanese",EnumField,Fine,false +Word.DocumentEncoding,"eucKorean",EnumField,Fine,false +Word.DocumentEncoding,"eucTaiwaneseTraditionalChinese",EnumField,Fine,false +Word.DocumentEncoding,"europa3",EnumField,Fine,false +Word.DocumentEncoding,"extAlphaLowercase",EnumField,Good,false +Word.DocumentEncoding,"greek",EnumField,Fine,false +Word.DocumentEncoding,"greekAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"hebrew",EnumField,Fine,false +Word.DocumentEncoding,"hzGbSimplifiedChinese",EnumField,Good,false +Word.DocumentEncoding,"ia5German",EnumField,Fine,false +Word.DocumentEncoding,"ia5Irv",EnumField,Fine,false +Word.DocumentEncoding,"ia5Norwegian",EnumField,Fine,false +Word.DocumentEncoding,"ia5Swedish",EnumField,Fine,false +Word.DocumentEncoding,"isciiAssamese",EnumField,Fine,false +Word.DocumentEncoding,"isciiBengali",EnumField,Fine,false +Word.DocumentEncoding,"isciiDevanagari",EnumField,Fine,false +Word.DocumentEncoding,"isciiGujarati",EnumField,Fine,false +Word.DocumentEncoding,"isciiKannada",EnumField,Fine,false +Word.DocumentEncoding,"isciiMalayalam",EnumField,Fine,false +Word.DocumentEncoding,"isciiOriya",EnumField,Fine,false +Word.DocumentEncoding,"isciiPunjabi",EnumField,Fine,false +Word.DocumentEncoding,"isciiTamil",EnumField,Fine,false +Word.DocumentEncoding,"isciiTelugu",EnumField,Fine,false +Word.DocumentEncoding,"iso2022CnSimplifiedChinese",EnumField,Good,false +Word.DocumentEncoding,"iso2022CnTraditionalChinese",EnumField,Fine,false +Word.DocumentEncoding,"iso2022JpJisX02011989",EnumField,Fine,false +Word.DocumentEncoding,"iso2022JpJisX02021984",EnumField,Fine,false +Word.DocumentEncoding,"iso2022JpNoHalfwidthKatakana",EnumField,Fine,false +Word.DocumentEncoding,"iso2022Kr",EnumField,Fine,false +Word.DocumentEncoding,"iso6937NonSpacingAccent",EnumField,Fine,false +Word.DocumentEncoding,"iso885915Latin9",EnumField,Fine,false +Word.DocumentEncoding,"iso88591Latin1",EnumField,Fine,false +Word.DocumentEncoding,"iso88592CentralEurope",EnumField,Fine,false +Word.DocumentEncoding,"iso88593Latin3",EnumField,Fine,false +Word.DocumentEncoding,"iso88594Baltic",EnumField,Fine,false +Word.DocumentEncoding,"iso88595Cyrillic",EnumField,Fine,false +Word.DocumentEncoding,"iso88596Arabic",EnumField,Fine,false +Word.DocumentEncoding,"iso88597Greek",EnumField,Fine,false +Word.DocumentEncoding,"iso88598Hebrew",EnumField,Fine,false +Word.DocumentEncoding,"iso88598HebrewLogical",EnumField,Fine,false +Word.DocumentEncoding,"iso88599Turkish",EnumField,Fine,false +Word.DocumentEncoding,"japaneseAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"japaneseShiftJis",EnumField,Good,false +Word.DocumentEncoding,"koi8R",EnumField,Fine,false +Word.DocumentEncoding,"koi8U",EnumField,Fine,false +Word.DocumentEncoding,"korean",EnumField,Fine,false +Word.DocumentEncoding,"koreanAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"koreanJohab",EnumField,Fine,false +Word.DocumentEncoding,"macArabic",EnumField,Fine,false +Word.DocumentEncoding,"macCroatia",EnumField,Fine,false +Word.DocumentEncoding,"macCyrillic",EnumField,Fine,false +Word.DocumentEncoding,"macGreek1",EnumField,Fine,false +Word.DocumentEncoding,"macHebrew",EnumField,Fine,false +Word.DocumentEncoding,"macIcelandic",EnumField,Fine,false +Word.DocumentEncoding,"macJapanese",EnumField,Fine,false +Word.DocumentEncoding,"macKorean",EnumField,Fine,false +Word.DocumentEncoding,"macLatin2",EnumField,Fine,false +Word.DocumentEncoding,"macRoman",EnumField,Fine,false +Word.DocumentEncoding,"macRomania",EnumField,Fine,false +Word.DocumentEncoding,"macSimplifiedChineseGb2312",EnumField,Good,false +Word.DocumentEncoding,"macTraditionalChineseBig5",EnumField,Fine,false +Word.DocumentEncoding,"macTurkish",EnumField,Fine,false +Word.DocumentEncoding,"macUkraine",EnumField,Fine,false +Word.DocumentEncoding,"oemArabic",EnumField,Fine,false +Word.DocumentEncoding,"oemBaltic",EnumField,Fine,false +Word.DocumentEncoding,"oemCanadianFrench",EnumField,Fine,false +Word.DocumentEncoding,"oemCyrillic",EnumField,Fine,false +Word.DocumentEncoding,"oemCyrillicIi",EnumField,Fine,false +Word.DocumentEncoding,"oemGreek437G",EnumField,Fine,false +Word.DocumentEncoding,"oemHebrew",EnumField,Fine,false +Word.DocumentEncoding,"oemIcelandic",EnumField,Fine,false +Word.DocumentEncoding,"oemModernGreek",EnumField,Fine,false +Word.DocumentEncoding,"oemMultilingualLatinI",EnumField,Fine,false +Word.DocumentEncoding,"oemMultilingualLatinIi",EnumField,Fine,false +Word.DocumentEncoding,"oemNordic",EnumField,Fine,false +Word.DocumentEncoding,"oemPortuguese",EnumField,Fine,false +Word.DocumentEncoding,"oemTurkish",EnumField,Fine,false +Word.DocumentEncoding,"oemUnitedStates",EnumField,Fine,false +Word.DocumentEncoding,"simplifiedChineseAutoDetect",EnumField,Good,false +Word.DocumentEncoding,"simplifiedChineseGb18030",EnumField,Good,false +Word.DocumentEncoding,"simplifiedChineseGbk",EnumField,Good,false +Word.DocumentEncoding,"t61",EnumField,Fine,false +Word.DocumentEncoding,"taiwanCns",EnumField,Fine,false +Word.DocumentEncoding,"taiwanEten",EnumField,Fine,false +Word.DocumentEncoding,"taiwanIbm5550",EnumField,Fine,false +Word.DocumentEncoding,"taiwanTca",EnumField,Fine,false +Word.DocumentEncoding,"taiwanTeleText",EnumField,Fine,false +Word.DocumentEncoding,"taiwanWang",EnumField,Fine,false +Word.DocumentEncoding,"thai",EnumField,Fine,false +Word.DocumentEncoding,"traditionalChineseAutoDetect",EnumField,Fine,false +Word.DocumentEncoding,"traditionalChineseBig5",EnumField,Fine,false +Word.DocumentEncoding,"turkish",EnumField,Fine,false +Word.DocumentEncoding,"unicodeBigEndian",EnumField,Fine,false +Word.DocumentEncoding,"unicodeLittleEndian",EnumField,Fine,false +Word.DocumentEncoding,"usaAscii",EnumField,Fine,false +Word.DocumentEncoding,"utf7",EnumField,Fine,false +Word.DocumentEncoding,"utf8",EnumField,Fine,false +Word.DocumentEncoding,"vietnamese",EnumField,Fine,false +Word.DocumentEncoding,"western",EnumField,Fine,false +Word.DocumentEndReviewOptions,N/A,Interface,Unknown,false +Word.DocumentEndReviewOptions,"includeAttachment",Property,Excellent,false +Word.DocumentEndReviewOptions,"recipients",Property,Excellent,false +Word.DocumentEndReviewOptions,"showMessage",Property,Excellent,false +Word.DocumentEndReviewOptions,"subject",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,N/A,Interface,Unknown,false +Word.DocumentExportAsFixedFormat2Options,"bitmapMissingFonts",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"createBookmarks",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"documentStructureTags",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"fixedFormatExtClassPtr",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"from",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"includeDocProps",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"item",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"keepInformationRightsManagement",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"openAfterExport",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"optimizeFor",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"optimizeForImageQuality",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"range",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"to",Property,Excellent,false +Word.DocumentExportAsFixedFormat2Options,"useIso19005_1",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,N/A,Interface,Unknown,false +Word.DocumentExportAsFixedFormat3Options,"bitmapMissingFonts",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"createBookmarks",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"documentStructureTags",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"fixedFormatExtClassPtr",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"from",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"improveExportTagging",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"includeDocProps",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"item",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"keepInformationRightsManagement",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"openAfterExport",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"optimizeFor",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"optimizeForImageQuality",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"range",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"to",Property,Excellent,false +Word.DocumentExportAsFixedFormat3Options,"useIso19005_1",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,N/A,Interface,Unknown,false +Word.DocumentExportAsFixedFormatOptions,"bitmapMissingFonts",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"createBookmarks",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"documentStructureTags",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"fixedFormatExtensionClassPointer",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"from",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"includeDocProps",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"item",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"keepInformationRightsManagement",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"openAfterExport",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"optimizeFor",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"range",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"to",Property,Excellent,false +Word.DocumentExportAsFixedFormatOptions,"useIso19005_1",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,N/A,Interface,Unknown,false +Word.DocumentFollowHyperlinkOptions,"addHistory",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"address",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"extraInfo",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"headerInfo",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"httpMethod",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"newWindow",Property,Excellent,false +Word.DocumentFollowHyperlinkOptions,"subAddress",Property,Excellent,false +Word.DocumentKind,N/A,Enum,Unknown,false +Word.DocumentKind,"email",EnumField,Fine,false +Word.DocumentKind,"letter",EnumField,Fine,false +Word.DocumentKind,"notSpecified",EnumField,Good,false Word.DocumentLibraryVersion,N/A,Class,Great,false Word.DocumentLibraryVersion,"comments",Property,Great,false Word.DocumentLibraryVersion,"context",Property,Excellent,false @@ -13378,6 +13822,30 @@ Word.DocumentLibraryVersionCollection,"load(propertyNamesAndPaths)",Method,Excel Word.DocumentLibraryVersionCollection,"toJSON()",Method,Excellent,false Word.DocumentLibraryVersionCollection,"track()",Method,Excellent,false Word.DocumentLibraryVersionCollection,"untrack()",Method,Excellent,false +Word.DocumentMergeOptions,N/A,Interface,Unknown,false +Word.DocumentMergeOptions,"addToRecentFiles",Property,Excellent,false +Word.DocumentMergeOptions,"detectFormatChanges",Property,Excellent,false +Word.DocumentMergeOptions,"mergeTarget",Property,Excellent,false +Word.DocumentMergeOptions,"useFormattingFrom",Property,Excellent,false +Word.DocumentPrintOutOptions,N/A,Interface,Unknown,false +Word.DocumentPrintOutOptions,"activePrinterMacGX",Property,Excellent,false +Word.DocumentPrintOutOptions,"append",Property,Excellent,false +Word.DocumentPrintOutOptions,"background",Property,Excellent,false +Word.DocumentPrintOutOptions,"collate",Property,Excellent,false +Word.DocumentPrintOutOptions,"copies",Property,Excellent,false +Word.DocumentPrintOutOptions,"from",Property,Excellent,false +Word.DocumentPrintOutOptions,"item",Property,Excellent,false +Word.DocumentPrintOutOptions,"manualDuplexPrint",Property,Excellent,false +Word.DocumentPrintOutOptions,"outputFileName",Property,Excellent,false +Word.DocumentPrintOutOptions,"pages",Property,Excellent,false +Word.DocumentPrintOutOptions,"pageType",Property,Excellent,false +Word.DocumentPrintOutOptions,"printToFile",Property,Excellent,false +Word.DocumentPrintOutOptions,"printZoomColumn",Property,Excellent,false +Word.DocumentPrintOutOptions,"printZoomPaperHeight",Property,Excellent,false +Word.DocumentPrintOutOptions,"printZoomPaperWidth",Property,Excellent,false +Word.DocumentPrintOutOptions,"printZoomRow",Property,Excellent,false +Word.DocumentPrintOutOptions,"range",Property,Excellent,false +Word.DocumentPrintOutOptions,"to",Property,Excellent,false Word.DocumentProperties,N/A,Class,Good,true Word.DocumentProperties,"applicationName",Property,Fine,false Word.DocumentProperties,"author",Property,Good,false @@ -13411,6 +13879,32 @@ Word.DocumentPropertyType,"boolean",EnumField,Fine,false Word.DocumentPropertyType,"date",EnumField,Fine,false Word.DocumentPropertyType,"number",EnumField,Fine,false Word.DocumentPropertyType,"string",EnumField,Fine,false +Word.DocumentProtectOptions,N/A,Interface,Unknown,false +Word.DocumentProtectOptions,"enforceStyleLock",Property,Excellent,false +Word.DocumentProtectOptions,"noReset",Property,Excellent,false +Word.DocumentProtectOptions,"password",Property,Excellent,false +Word.DocumentProtectOptions,"useInformationRightsManagement",Property,Excellent,false +Word.DocumentRangeOptions,N/A,Interface,Unknown,false +Word.DocumentRangeOptions,"end",Property,Excellent,false +Word.DocumentRangeOptions,"start",Property,Excellent,false +Word.DocumentReplyWithChangesOptions,N/A,Interface,Unknown,false +Word.DocumentReplyWithChangesOptions,"includeAttachment",Property,Excellent,false +Word.DocumentReplyWithChangesOptions,"recipients",Property,Excellent,false +Word.DocumentReplyWithChangesOptions,"showMessage",Property,Excellent,false +Word.DocumentReplyWithChangesOptions,"subject",Property,Excellent,false +Word.DocumentSendFaxOverInternetOptions,N/A,Interface,Unknown,false +Word.DocumentSendFaxOverInternetOptions,"recipients",Property,Excellent,false +Word.DocumentSendFaxOverInternetOptions,"showMessage",Property,Excellent,false +Word.DocumentSendFaxOverInternetOptions,"subject",Property,Excellent,false +Word.DocumentSendForReviewOptions,N/A,Interface,Unknown,false +Word.DocumentSendForReviewOptions,"includeAttachment",Property,Excellent,false +Word.DocumentSendForReviewOptions,"recipients",Property,Excellent,false +Word.DocumentSendForReviewOptions,"showMessage",Property,Excellent,false +Word.DocumentSendForReviewOptions,"subject",Property,Excellent,false +Word.DocumentType,N/A,Enum,Unknown,false +Word.DocumentType,"document",EnumField,Fine,false +Word.DocumentType,"frameset",EnumField,Fine,false +Word.DocumentType,"template",EnumField,Fine,false Word.DropCap,N/A,Class,Unknown,false Word.DropCap,"context",Property,Excellent,false Word.DropCap,"distanceFromText",Property,Fine,false @@ -13514,6 +14008,24 @@ Word.EventType,"contentControlSelectionChanged",EnumField,Fine,false Word.EventType,"paragraphAdded",EnumField,Fine,false Word.EventType,"paragraphChanged",EnumField,Fine,false Word.EventType,"paragraphDeleted",EnumField,Fine,false +Word.ExportCreateBookmarks,N/A,Enum,Good,false +Word.ExportCreateBookmarks,"headings",EnumField,Good,false +Word.ExportCreateBookmarks,"none",EnumField,Fine,false +Word.ExportCreateBookmarks,"wordBookmarks",EnumField,Good,false +Word.ExportFormat,N/A,Enum,Unknown,false +Word.ExportFormat,"pdf",EnumField,Fine,false +Word.ExportFormat,"xps",EnumField,Fine,false +Word.ExportItem,N/A,Enum,Unknown,false +Word.ExportItem,"documentContent",EnumField,Fine,false +Word.ExportItem,"documentWithMarkup",EnumField,Fine,false +Word.ExportOptimizeFor,N/A,Enum,Unknown,false +Word.ExportOptimizeFor,"onScreen",EnumField,Fine,false +Word.ExportOptimizeFor,"print",EnumField,Fine,false +Word.ExportRange,N/A,Enum,Unknown,false +Word.ExportRange,"allDocument",EnumField,Fine,false +Word.ExportRange,"currentPage",EnumField,Fine,false +Word.ExportRange,"fromTo",EnumField,Good,false +Word.ExportRange,"selection",EnumField,Fine,false Word.ExtrusionColorType,N/A,Enum,Unknown,false Word.ExtrusionColorType,"automatic",EnumField,Fine,false Word.ExtrusionColorType,"custom",EnumField,Fine,false @@ -13676,6 +14188,32 @@ Word.FieldType,"userAddress",EnumField,Good,false Word.FieldType,"userInitials",EnumField,Good,false Word.FieldType,"userName",EnumField,Good,false Word.FieldType,"xe",EnumField,Good,false +Word.FileSaveFormat,N/A,Enum,Unknown,false +Word.FileSaveFormat,"document",EnumField,Fine,false +Word.FileSaveFormat,"documentDefault",EnumField,Good,false +Word.FileSaveFormat,"dosText",EnumField,Fine,false +Word.FileSaveFormat,"dosTextLineBreaks",EnumField,Fine,false +Word.FileSaveFormat,"filteredHtml",EnumField,Fine,false +Word.FileSaveFormat,"flatXml",EnumField,Fine,false +Word.FileSaveFormat,"flatXmlMacroEnabled",EnumField,Good,false +Word.FileSaveFormat,"flatXmlTemplate",EnumField,Fine,false +Word.FileSaveFormat,"flatXmlTemplateMacroEnabled",EnumField,Good,false +Word.FileSaveFormat,"html",EnumField,Fine,false +Word.FileSaveFormat,"openDocumentText",EnumField,Fine,false +Word.FileSaveFormat,"pdf",EnumField,Fine,false +Word.FileSaveFormat,"rtf",EnumField,Fine,false +Word.FileSaveFormat,"strictOpenXmlDocument",EnumField,Fine,false +Word.FileSaveFormat,"template",EnumField,Fine,false +Word.FileSaveFormat,"text",EnumField,Fine,false +Word.FileSaveFormat,"textLineBreaks",EnumField,Fine,false +Word.FileSaveFormat,"unicodeText",EnumField,Fine,false +Word.FileSaveFormat,"webArchive",EnumField,Fine,false +Word.FileSaveFormat,"xml",EnumField,Fine,false +Word.FileSaveFormat,"xmlDocument",EnumField,Fine,false +Word.FileSaveFormat,"xmlDocumentMacroEnabled",EnumField,Good,false +Word.FileSaveFormat,"xmlTemplate",EnumField,Fine,false +Word.FileSaveFormat,"xmlTemplateMacroEnabled",EnumField,Good,false +Word.FileSaveFormat,"xps",EnumField,Fine,false Word.FillFormat,N/A,Class,Unknown,false Word.FillFormat,"backgroundColor",Property,Great,false Word.FillFormat,"context",Property,Excellent,false @@ -14070,6 +14608,11 @@ Word.GoToItem,"proofreadingError",EnumField,Good,false Word.GoToItem,"section",EnumField,Fine,false Word.GoToItem,"spellingError",EnumField,Good,false Word.GoToItem,"table",EnumField,Fine,false +Word.GoToOptions,N/A,Interface,Unknown,false +Word.GoToOptions,"count",Property,Excellent,false +Word.GoToOptions,"direction",Property,Excellent,false +Word.GoToOptions,"item",Property,Excellent,false +Word.GoToOptions,"name",Property,Excellent,false Word.GradientColorType,N/A,Enum,Good,false Word.GradientColorType,"mixed",EnumField,Excellent,false Word.GradientColorType,"multiColor",EnumField,Fine,false @@ -14157,6 +14700,30 @@ Word.HorizontalInVerticalType,N/A,Enum,Unknown,false Word.HorizontalInVerticalType,"fitInLine",EnumField,Fine,false Word.HorizontalInVerticalType,"none",EnumField,Fine,false Word.HorizontalInVerticalType,"resizeLine",EnumField,Fine,false +Word.HtmlDivision,N/A,Class,Missing,false +Word.HtmlDivision,"context",Property,Excellent,false +Word.HtmlDivision,"htmlDivisions",Property,Missing,false +Word.HtmlDivision,"leftIndent",Property,Excellent,false +Word.HtmlDivision,"range",Property,Good,false +Word.HtmlDivision,"rightIndent",Property,Great,false +Word.HtmlDivision,"spaceAfter",Property,Great,false +Word.HtmlDivision,"spaceBefore",Property,Great,false +Word.HtmlDivision,"delete()",Method,Fine,false +Word.HtmlDivision,"htmlDivisionParent(levelsUp)",Method,Great,false +Word.HtmlDivision,"load(options)",Method,Excellent,false +Word.HtmlDivision,"load(propertyNames)",Method,Excellent,false +Word.HtmlDivision,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.HtmlDivision,"toJSON()",Method,Excellent,false +Word.HtmlDivision,"track()",Method,Excellent,false +Word.HtmlDivision,"untrack()",Method,Excellent,false +Word.HtmlDivisionCollection,N/A,Class,Unknown,false +Word.HtmlDivisionCollection,"context",Property,Excellent,false +Word.HtmlDivisionCollection,"items",Property,Poor,false +Word.HtmlDivisionCollection,"getItemAt(index)",Method,Excellent,false +Word.HtmlDivisionCollection,"load(options)",Method,Excellent,false +Word.HtmlDivisionCollection,"load(propertyNames)",Method,Excellent,false +Word.HtmlDivisionCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.HtmlDivisionCollection,"toJSON()",Method,Excellent,false Word.Hyperlink,N/A,Class,Unknown,false Word.Hyperlink,"address",Property,Excellent,false Word.Hyperlink,"context",Property,Excellent,false @@ -14658,6 +15225,12 @@ Word.LineDashStyle,"squareDot",EnumField,Fine,false Word.LineDashStyle,"sysDash",EnumField,Fine,false Word.LineDashStyle,"sysDashDot",EnumField,Fine,false Word.LineDashStyle,"sysDot",EnumField,Fine,false +Word.LineEndingType,N/A,Enum,Fine,false +Word.LineEndingType,"crlf",EnumField,Fine,false +Word.LineEndingType,"crOnly",EnumField,Fine,false +Word.LineEndingType,"lfcr",EnumField,Fine,false +Word.LineEndingType,"lfOnly",EnumField,Fine,false +Word.LineEndingType,"lsps",EnumField,Fine,false Word.LineFormat,N/A,Class,Unknown,false Word.LineFormat,"backgroundColor",Property,Good,false Word.LineFormat,"beginArrowheadLength",Property,Great,false @@ -15045,6 +15618,10 @@ Word.LocationRelation,"insideStart",EnumField,Fine,false Word.LocationRelation,"overlapsAfter",EnumField,Fine,false Word.LocationRelation,"overlapsBefore",EnumField,Fine,false Word.LocationRelation,"unrelated",EnumField,Good,false +Word.MergeTarget,N/A,Enum,Unknown,false +Word.MergeTarget,"current",EnumField,Fine,false +Word.MergeTarget,"new",EnumField,Fine,false +Word.MergeTarget,"selected",EnumField,Fine,false Word.MovementType,N/A,Enum,Good,false Word.MovementType,"extend",EnumField,Fine,false Word.MovementType,"move",EnumField,Fine,false @@ -15134,7 +15711,7 @@ Word.OleFormat,"iconPath",Property,Good,false Word.OleFormat,"isDisplayedAsIcon",Property,Great,false Word.OleFormat,"isFormattingPreservedOnUpdate",Property,Excellent,false Word.OleFormat,"label",Property,Excellent,false -Word.OleFormat,"progID",Property,Great,false +Word.OleFormat,"progId",Property,Great,false Word.OleFormat,"activate()",Method,Fine,false Word.OleFormat,"activateAs(classType)",Method,Excellent,false Word.OleFormat,"doVerb(verbIndex)",Method,Good,false @@ -15974,6 +16551,32 @@ Word.PresetThreeDimensionalFormat,"format7",EnumField,Fine,false Word.PresetThreeDimensionalFormat,"format8",EnumField,Fine,false Word.PresetThreeDimensionalFormat,"format9",EnumField,Fine,false Word.PresetThreeDimensionalFormat,"mixed",EnumField,Fine,false +Word.PrintOutItem,N/A,Enum,Unknown,false +Word.PrintOutItem,"autoTextEntries",EnumField,Fine,false +Word.PrintOutItem,"comments",EnumField,Fine,false +Word.PrintOutItem,"documentContent",EnumField,Fine,false +Word.PrintOutItem,"documentWithMarkup",EnumField,Fine,false +Word.PrintOutItem,"envelope",EnumField,Fine,false +Word.PrintOutItem,"keyAssignments",EnumField,Fine,false +Word.PrintOutItem,"markup",EnumField,Fine,false +Word.PrintOutItem,"properties",EnumField,Fine,false +Word.PrintOutItem,"styles",EnumField,Fine,false +Word.PrintOutPages,N/A,Enum,Unknown,false +Word.PrintOutPages,"all",EnumField,Fine,false +Word.PrintOutPages,"evenOnly",EnumField,Fine,false +Word.PrintOutPages,"oddOnly",EnumField,Fine,false +Word.PrintOutRange,N/A,Enum,Unknown,false +Word.PrintOutRange,"allDocument",EnumField,Fine,false +Word.PrintOutRange,"currentPage",EnumField,Fine,false +Word.PrintOutRange,"fromTo",EnumField,Fine,false +Word.PrintOutRange,"rangeOfPages",EnumField,Good,false +Word.PrintOutRange,"selection",EnumField,Fine,false +Word.ProtectionType,N/A,Enum,Unknown,false +Word.ProtectionType,"allowOnlyComments",EnumField,Fine,false +Word.ProtectionType,"allowOnlyFormFields",EnumField,Good,false +Word.ProtectionType,"allowOnlyReading",EnumField,Fine,false +Word.ProtectionType,"allowOnlyRevisions",EnumField,Fine,false +Word.ProtectionType,"noProtection",EnumField,Fine,false Word.Range,N/A,Class,Unknown,true Word.Range,"bold",Property,Good,false Word.Range,"boldBidirectional",Property,Great,false @@ -16123,6 +16726,26 @@ Word.RangeScopedCollection,"load(propertyNamesAndPaths)",Method,Excellent,false Word.RangeScopedCollection,"toJSON()",Method,Excellent,false Word.RangeScopedCollection,"track()",Method,Excellent,false Word.RangeScopedCollection,"untrack()",Method,Excellent,false +Word.ReadabilityStatistic,N/A,Class,Unknown,false +Word.ReadabilityStatistic,"context",Property,Excellent,false +Word.ReadabilityStatistic,"name",Property,Fine,false +Word.ReadabilityStatistic,"value",Property,Good,false +Word.ReadabilityStatistic,"load(options)",Method,Excellent,false +Word.ReadabilityStatistic,"load(propertyNames)",Method,Excellent,false +Word.ReadabilityStatistic,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ReadabilityStatistic,"toJSON()",Method,Excellent,false +Word.ReadabilityStatistic,"track()",Method,Excellent,false +Word.ReadabilityStatistic,"untrack()",Method,Excellent,false +Word.ReadabilityStatisticCollection,N/A,Class,Unknown,false +Word.ReadabilityStatisticCollection,"context",Property,Excellent,false +Word.ReadabilityStatisticCollection,"items",Property,Poor,false +Word.ReadabilityStatisticCollection,"getItemAt(index)",Method,Good,false +Word.ReadabilityStatisticCollection,"load(options)",Method,Excellent,false +Word.ReadabilityStatisticCollection,"load(propertyNames)",Method,Excellent,false +Word.ReadabilityStatisticCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ReadabilityStatisticCollection,"toJSON()",Method,Excellent,false +Word.ReadabilityStatisticCollection,"track()",Method,Excellent,false +Word.ReadabilityStatisticCollection,"untrack()",Method,Excellent,false Word.ReadingLayoutMargin,N/A,Enum,Unknown,false Word.ReadingLayoutMargin,"automatic",EnumField,Fine,false Word.ReadingLayoutMargin,"full",EnumField,Fine,false @@ -16202,6 +16825,27 @@ 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.RemoveDocInfoType,N/A,Enum,Unknown,false +Word.RemoveDocInfoType,"all",EnumField,Fine,false +Word.RemoveDocInfoType,"atMentions",EnumField,Fine,false +Word.RemoveDocInfoType,"commentReactions",EnumField,Fine,false +Word.RemoveDocInfoType,"comments",EnumField,Fine,false +Word.RemoveDocInfoType,"contentType",EnumField,Fine,false +Word.RemoveDocInfoType,"documentIntelligence",EnumField,Fine,false +Word.RemoveDocInfoType,"documentManagementPolicy",EnumField,Fine,false +Word.RemoveDocInfoType,"documentProperties",EnumField,Fine,false +Word.RemoveDocInfoType,"documentServerProperties",EnumField,Fine,false +Word.RemoveDocInfoType,"documentTasks",EnumField,Fine,false +Word.RemoveDocInfoType,"documentWorkspace",EnumField,Fine,false +Word.RemoveDocInfoType,"emailHeader",EnumField,Fine,false +Word.RemoveDocInfoType,"inkAnnotations",EnumField,Fine,false +Word.RemoveDocInfoType,"removePersonalInformation",EnumField,Fine,false +Word.RemoveDocInfoType,"revisions",EnumField,Fine,false +Word.RemoveDocInfoType,"routingSlip",EnumField,Fine,false +Word.RemoveDocInfoType,"sendForReview",EnumField,Fine,false +Word.RemoveDocInfoType,"taskpaneWebExtensions",EnumField,Fine,false +Word.RemoveDocInfoType,"template",EnumField,Fine,false +Word.RemoveDocInfoType,"versions",EnumField,Fine,false Word.RepeatingSectionContentControl,N/A,Class,Unknown,false Word.RepeatingSectionContentControl,"allowInsertDeleteSection",Property,Great,false Word.RepeatingSectionContentControl,"appearance",Property,Good,false @@ -16379,6 +17023,18 @@ Word.SaveConfiguration,N/A,Enum,Great,false Word.SaveConfiguration,"doNotSaveChanges",EnumField,Great,false Word.SaveConfiguration,"promptToSaveChanges",EnumField,Great,false Word.SaveConfiguration,"saveChanges",EnumField,Great,false +Word.ScreenSize,N/A,Enum,Unknown,false +Word.ScreenSize,"size1024x768",EnumField,Fine,false +Word.ScreenSize,"size1152x882",EnumField,Fine,false +Word.ScreenSize,"size1152x900",EnumField,Fine,false +Word.ScreenSize,"size1280x1024",EnumField,Fine,false +Word.ScreenSize,"size1600x1200",EnumField,Fine,false +Word.ScreenSize,"size1800x1440",EnumField,Fine,false +Word.ScreenSize,"size1920x1200",EnumField,Fine,false +Word.ScreenSize,"size544x376",EnumField,Fine,false +Word.ScreenSize,"size640x480",EnumField,Fine,false +Word.ScreenSize,"size720x512",EnumField,Fine,false +Word.ScreenSize,"size800x600",EnumField,Fine,false Word.SearchOptions,N/A,Class,Unknown,true Word.SearchOptions,"context",Property,Excellent,false Word.SearchOptions,"ignorePunct",Property,Excellent,false @@ -16655,6 +17311,12 @@ Word.SelectionType,"normal",EnumField,Fine,false Word.SelectionType,"noSelection",EnumField,Fine,false Word.SelectionType,"row",EnumField,Fine,false Word.SelectionType,"selectionShape",EnumField,Fine,false +Word.SelectNodesOptions,N/A,Interface,Unknown,false +Word.SelectNodesOptions,"fastSearchSkippingTextNodes",Property,Excellent,false +Word.SelectNodesOptions,"prefixMapping",Property,Excellent,false +Word.SelectSingleNodeOptions,N/A,Interface,Unknown,false +Word.SelectSingleNodeOptions,"fastSearchSkippingTextNodes",Property,Excellent,false +Word.SelectSingleNodeOptions,"prefixMapping",Property,Excellent,false Word.Setting,N/A,Class,Unknown,true Word.Setting,"context",Property,Excellent,false Word.Setting,"key",Property,Poor,true @@ -17047,6 +17709,14 @@ Word.SpecialPane,"primaryHeader",EnumField,Fine,false Word.SpecialPane,"revisions",EnumField,Fine,false Word.SpecialPane,"revisionsHoriz",EnumField,Fine,false Word.SpecialPane,"revisionsVert",EnumField,Fine,false +Word.Statistic,N/A,Enum,Unknown,false +Word.Statistic,"characters",EnumField,Fine,false +Word.Statistic,"charactersWithSpaces",EnumField,Fine,false +Word.Statistic,"farEastCharacters",EnumField,Fine,false +Word.Statistic,"lines",EnumField,Fine,false +Word.Statistic,"pages",EnumField,Fine,false +Word.Statistic,"paragraphs",EnumField,Fine,false +Word.Statistic,"words",EnumField,Fine,false Word.StoryType,N/A,Enum,Unknown,false Word.StoryType,"comments",EnumField,Fine,false Word.StoryType,"endnoteContinuationNotice",EnumField,Fine,false @@ -17804,6 +18474,12 @@ Word.TabStopCollection,"load(propertyNamesAndPaths)",Method,Excellent,false Word.TabStopCollection,"toJSON()",Method,Excellent,false Word.TabStopCollection,"track()",Method,Excellent,false Word.TabStopCollection,"untrack()",Method,Excellent,false +Word.TargetBrowser,N/A,Enum,Unknown,false +Word.TargetBrowser,"ie4",EnumField,Fine,false +Word.TargetBrowser,"ie5",EnumField,Fine,false +Word.TargetBrowser,"ie6",EnumField,Fine,false +Word.TargetBrowser,"v3",EnumField,Fine,false +Word.TargetBrowser,"v4",EnumField,Fine,false Word.Template,N/A,Class,Missing,false Word.Template,"buildingBlockEntries",Property,Great,false Word.Template,"buildingBlockTypes",Property,Great,false @@ -17877,7 +18553,6 @@ Word.TextColumnCollection,"add(options)",Method,Great,false Word.TextColumnCollection,"getFlowDirection()",Method,Fine,false Word.TextColumnCollection,"getHasLineBetween()",Method,Good,false Word.TextColumnCollection,"getIsEvenlySpaced()",Method,Poor,false -Word.TextColumnCollection,"getItem(index)",Method,Fine,false Word.TextColumnCollection,"load(options)",Method,Excellent,false Word.TextColumnCollection,"load(propertyNames)",Method,Excellent,false Word.TextColumnCollection,"load(propertyNamesAndPaths)",Method,Excellent,false @@ -18085,6 +18760,10 @@ Word.UnderlineType,"wave",EnumField,Fine,false Word.UnderlineType,"waveDouble",EnumField,Fine,false Word.UnderlineType,"waveHeavy",EnumField,Fine,false Word.UnderlineType,"word",EnumField,Fine,false +Word.UseFormattingFrom,N/A,Enum,Unknown,false +Word.UseFormattingFrom,"current",EnumField,Fine,false +Word.UseFormattingFrom,"prompt",EnumField,Fine,false +Word.UseFormattingFrom,"selected",EnumField,Fine,false Word.VerticalAlignment,N/A,Enum,Fine,true Word.VerticalAlignment,"bottom",EnumField,Fine,false Word.VerticalAlignment,"center",EnumField,Fine,false @@ -18169,6 +18848,25 @@ Word.ViewType,"print",EnumField,Fine,false Word.ViewType,"printPreview",EnumField,Fine,false Word.ViewType,"reading",EnumField,Fine,false Word.ViewType,"web",EnumField,Fine,false +Word.WebSettings,N/A,Class,Unknown,false +Word.WebSettings,"allowPng",Property,Excellent,false +Word.WebSettings,"context",Property,Excellent,false +Word.WebSettings,"encoding",Property,Excellent,false +Word.WebSettings,"folderSuffix",Property,Great,false +Word.WebSettings,"organizeInFolder",Property,Excellent,false +Word.WebSettings,"pixelsPerInch",Property,Great,false +Word.WebSettings,"relyOnCSS",Property,Excellent,false +Word.WebSettings,"relyOnVectorMarkupLanguage",Property,Excellent,false +Word.WebSettings,"screenSize",Property,Great,false +Word.WebSettings,"targetBrowser",Property,Great,false +Word.WebSettings,"useLongFileNames",Property,Excellent,false +Word.WebSettings,"load(options)",Method,Excellent,false +Word.WebSettings,"load(propertyNames)",Method,Excellent,false +Word.WebSettings,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.WebSettings,"toJSON()",Method,Excellent,false +Word.WebSettings,"track()",Method,Excellent,false +Word.WebSettings,"untrack()",Method,Excellent,false +Word.WebSettings,"useDefaultFolderSuffix()",Method,Great,false Word.Window,N/A,Class,Missing,true Word.Window,"activePane",Property,Poor,true Word.Window,"areRulersDisplayed",Property,Great,false @@ -18268,6 +18966,67 @@ Word.XmlMapping,"setMappingByNode(node)",Method,Fine,false Word.XmlMapping,"toJSON()",Method,Excellent,false Word.XmlMapping,"track()",Method,Excellent,false Word.XmlMapping,"untrack()",Method,Excellent,false +Word.XmlNode,N/A,Class,Unknown,false +Word.XmlNode,"attributes",Property,Excellent,false +Word.XmlNode,"baseName",Property,Poor,false +Word.XmlNode,"childNodes",Property,Excellent,false +Word.XmlNode,"context",Property,Excellent,false +Word.XmlNode,"firstChild",Property,Excellent,false +Word.XmlNode,"hasChildNodes",Property,Great,false +Word.XmlNode,"lastChild",Property,Excellent,false +Word.XmlNode,"level",Property,Excellent,false +Word.XmlNode,"namespaceUri",Property,Good,false +Word.XmlNode,"nextSibling",Property,Excellent,false +Word.XmlNode,"nodeType",Property,Poor,false +Word.XmlNode,"nodeValue",Property,Excellent,false +Word.XmlNode,"ownerDocument",Property,Poor,false +Word.XmlNode,"parentNode",Property,Poor,false +Word.XmlNode,"placeholderText",Property,Excellent,false +Word.XmlNode,"previousSibling",Property,Excellent,false +Word.XmlNode,"range",Property,Excellent,false +Word.XmlNode,"text",Property,Excellent,false +Word.XmlNode,"validationErrorText",Property,Excellent,false +Word.XmlNode,"validationStatus",Property,Good,false +Word.XmlNode,"copy()",Method,Great,false +Word.XmlNode,"cut()",Method,Great,false +Word.XmlNode,"delete()",Method,Great,false +Word.XmlNode,"load(options)",Method,Excellent,false +Word.XmlNode,"load(propertyNames)",Method,Excellent,false +Word.XmlNode,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.XmlNode,"removeChild(childElement)",Method,Excellent,false +Word.XmlNode,"selectNodes(xPath, options)",Method,Excellent,false +Word.XmlNode,"selectSingleNode(xPath, options)",Method,Excellent,false +Word.XmlNode,"setValidationError(status, options)",Method,Excellent,false +Word.XmlNode,"setValidationError(status, options)",Method,Excellent,false +Word.XmlNode,"toJSON()",Method,Excellent,false +Word.XmlNode,"track()",Method,Excellent,false +Word.XmlNode,"untrack()",Method,Excellent,false +Word.XmlNode,"validate()",Method,Good,false +Word.XmlNodeCollection,N/A,Class,Unknown,false +Word.XmlNodeCollection,"context",Property,Excellent,false +Word.XmlNodeCollection,"items",Property,Poor,false +Word.XmlNodeCollection,"getItem(index)",Method,Good,false +Word.XmlNodeCollection,"getItemAt(index)",Method,Great,false +Word.XmlNodeCollection,"load(options)",Method,Excellent,false +Word.XmlNodeCollection,"load(propertyNames)",Method,Excellent,false +Word.XmlNodeCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.XmlNodeCollection,"toJSON()",Method,Excellent,false +Word.XmlNodeCollection,"track()",Method,Excellent,false +Word.XmlNodeCollection,"untrack()",Method,Excellent,false +Word.XmlNodeLevel,N/A,Enum,Unknown,false +Word.XmlNodeLevel,"cell",EnumField,Fine,false +Word.XmlNodeLevel,"inline",EnumField,Fine,false +Word.XmlNodeLevel,"paragraph",EnumField,Fine,false +Word.XmlNodeLevel,"row",EnumField,Fine,false +Word.XmlNodeSetValidationErrorOptions,N/A,Interface,Excellent,false +Word.XmlNodeSetValidationErrorOptions,"clearedAutomatically",Property,Excellent,false +Word.XmlNodeSetValidationErrorOptions,"errorText",Property,Excellent,false +Word.XmlNodeType,N/A,Enum,Unknown,false +Word.XmlNodeType,"attribute",EnumField,Good,false +Word.XmlNodeType,"element",EnumField,Fine,false Word.XmlSetMappingOptions,N/A,Interface,Unknown,false Word.XmlSetMappingOptions,"prefixMapping",Property,Excellent,false -Word.XmlSetMappingOptions,"source",Property,Excellent,false \ No newline at end of file +Word.XmlSetMappingOptions,"source",Property,Excellent,false +Word.XmlValidationStatus,N/A,Enum,Unknown,false +Word.XmlValidationStatus,"custom",EnumField,Good,false +Word.XmlValidationStatus,"ok",EnumField,Fine,false \ No newline at end of file diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh index 60565597f8..34a39ae79f 100644 --- a/generate-docs/GenerateDocs.sh +++ b/generate-docs/GenerateDocs.sh @@ -94,24 +94,21 @@ npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_2/power npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ./tool-inputs/powerpoint-base.d.ts "Api set: PowerPointApi 1.1" configs/powerpoint-1_1-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts "Api set: WordApiOnline 1.1" configs/word-online-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_online/word-online1.d.ts "Api set: WordApiDesktop 1.2" configs/word-desktop-1_2-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-online1.d.ts api-extractor-inputs-word-release/word_online/word-online2.d.ts "Api set: WordApiDesktop 1.1" configs/word-desktop-1_1-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-online2.d.ts api-extractor-inputs-word-release/word_online/word-online3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-online3.d.ts api-extractor-inputs-word-release/word_online/word-online4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-online4.d.ts api-extractor-inputs-word-release/word_online/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts "Api set: WordApiDesktop 1.2" configs/word-desktop-1_2-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts "Api set: WordApiDesktop 1.1" configs/word-desktop-1_1-config.json -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts "Api set: WordApi 1.8" configs/word-1_8-config.json -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts "Api set: WordApi 1.7" configs/word-1_7-config.json -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts "Api set: WordApi 1.6" configs/word-1_6-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts "Api set: WordApiDesktop 1.2" configs/word-desktop-1_2-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json +npx version-remover api-extractor-inputs-word-release/word_online/word-online2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts "Api set: WordApiOnline 1.1" configs/word-online-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts "Api set: WordApi 1.8" configs/word-1_8-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts "Api set: WordApi 1.7" configs/word-1_7-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts "Api set: WordApi 1.6" configs/word-1_6-config.json npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts "Api set: WordApi 1.5" configs/word-1_5-config.json npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json @@ -181,7 +178,7 @@ npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint. npx whats-new api-extractor-inputs-word/word.d.ts api-extractor-inputs-word-release/word_online/word-init.d.ts ../docs/includes/word-preview javascript/api/word/ configs/word-preview-config.json npx whats-new api-extractor-inputs-word-release/word_online/word.d.ts api-extractor-inputs-word-release/word_1_9/word.d.ts ../docs/includes/word-online javascript/api/word/ configs/word-online-config.json -npx whats-new api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts ../docs/includes/word-desktop-1_2 javascript/api/word/ configs/word-desktop-1_2-config.json +npx whats-new api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts ../docs/includes/word-desktop-1_2 javascript/api/word/ configs/word-desktop-1_2-config.json npx whats-new api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts ../docs/includes/word-desktop-1_1 javascript/api/word/ configs/word-desktop-1_1-config.json npx whats-new api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_5_hidden_document javascript/api/word/ configs/word-1_5_hidden_document-config.json npx whats-new api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_4_hidden_document javascript/api/word/ configs/word-1_4_hidden_document-config.json diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts index 719ec8a935..edd47400de 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts @@ -1437,7 +1437,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; - + /** + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly comboBoxContentControl: Word.ComboBoxContentControl; /** * Gets the collection of content control objects in the content control. * @@ -1445,7 +1451,13 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; - + /** + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly dropDownListContentControl: Word.DropDownListContentControl; /** * Gets the collection of endnotes in the content control. * @@ -2085,8 +2097,152 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.ContentControlCollectionData; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItem 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value: string; + /** + * 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.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ContentControlListItem): void; + /** + * Deletes the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + delete(): void; + /** + * Selects the list item and sets the text of the content control to the value of the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + select(): 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.ContentControlListItemLoadOptions): Word.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemData; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItemCollection 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.ContentControlListItem[]; + /** + * Gets the first list item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.9] + */ + getFirst(): Word.ContentControlListItem; + /** + * Gets the first list item 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 1.9] + */ + getFirstOrNullObject(): Word.ContentControlListItem; + /** + * 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.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemCollectionData; + } /** * Specifies the options that define which content controls are returned. * @@ -3494,8 +3650,132 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.DocumentPropertiesData; } - - + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class DropDownListContentControl 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 collection of list items in the dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DropDownListContentControlData; + } + /** + * The data specific to content controls of type 'ComboBox'. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ComboBoxContentControl 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 collection of list items in the combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ComboBoxContentControlData; + } /** * Represents a field. * @@ -11927,9 +12207,27 @@ export declare namespace Word { } /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ export interface ContentControlListItemUpdateData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ export interface ContentControlListItemCollectionUpdateData { @@ -13387,7 +13685,13 @@ export declare namespace Word { * [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] + */ + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** * Gets the collection of content control objects in the content control. * @@ -13395,7 +13699,13 @@ export declare namespace Word { * [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] + */ + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** * Gets the collection of field objects in the content control. * @@ -13545,9 +13855,27 @@ export declare namespace Word { } /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ export interface ContentControlListItemData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ export interface ContentControlListItemCollectionData { @@ -16054,8 +16382,72 @@ export declare namespace Word { */ type?: boolean; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemLoadOptions { + /** + 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemCollectionLoadOptions { + /** + 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: Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } /** * Represents a custom property. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts index fa74e62a75..719ec8a935 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts @@ -43,7 +43,42 @@ export declare namespace Word { */ berry = "Berry", } - + /** + * Properties defining the behavior of the pop-up menu for a given critique. + * + * @remarks + * [Api set: WordApi 1.8] + */ + export interface CritiquePopupOptions { + /** + * Gets the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu. + * + * @remarks + * [Api set: WordApi 1.8] + */ + brandingTextResourceId: string; + /** + * Gets the manifest resource ID of the string to use as the subtitle. + * + * @remarks + * [Api set: WordApi 1.8] + */ + subtitleResourceId: string; + /** + * Gets the suggestions to display in the critique pop-up menu. + * + * @remarks + * [Api set: WordApi 1.8] + */ + suggestions: string[]; + /** + * Gets the manifest resource ID of the string to use as the title. + * + * @remarks + * [Api set: WordApi 1.8] + */ + titleResourceId: string; + } /** * Critique that will be rendered as underline for the specified part of paragraph in the document. * @@ -65,7 +100,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ length: number; - + /** + * Specifies the behavior of the pop-up menu for the critique. + * + * @remarks + * [Api set: WordApi 1.8] + */ + popupOptions?: Word.CritiquePopupOptions; /** * Specifies the start index of the critique inside paragraph. * @@ -319,7 +360,35 @@ export declare namespace Word { */ id: string; } - + /** + * Represents action information that's passed back on annotation pop-up action event. + * + * @remarks + * [Api set: WordApi 1.8] + */ + export interface AnnotationPopupActionEventArgs { + /** + * Specifies the chosen action in the pop-up menu. + * + * @remarks + * [Api set: WordApi 1.8] + */ + action: string; + /** + * Specifies the accepted suggestion (only populated when accepting a critique suggestion). + * + * @remarks + * [Api set: WordApi 1.8] + */ + critiqueSuggestion: string; + /** + * Specifies the annotation ID for which the event was fired. + * + * @remarks + * [Api set: WordApi 1.8] + */ + id: string; + } /** * Contains a collection of {@link Word.Annotation} objects. * @@ -2966,7 +3035,15 @@ export declare namespace Word { * @eventproperty */ readonly onAnnotationInserted: OfficeExtension.EventHandlers; - + /** + * Occurs when the user performs an action in an annotation pop-up menu. + * + * @remarks + * [Api set: WordApi 1.8] + * + * @eventproperty + */ + readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; /** * Occurs when the user deletes one or more annotations. * @@ -5848,7 +5925,14 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; - + /** + * Highlights the range temporarily without changing document content. + To highlight the text permanently, set the range's Font.HighlightColor. + * + * @remarks + * [Api set: WordApi 1.8] + */ + highlight(): void; /** * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. * @@ -6037,7 +6121,13 @@ export declare namespace Word { * @param range - Required. Another range. */ intersectWithOrNullObject(range: Word.Range): Word.Range; - + /** + * Removes the highlight added by the Highlight function if any. + * + * @remarks + * [Api set: WordApi 1.8] + */ + removeHighlight(): void; /** * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. * @@ -8791,7 +8881,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ annotationRemoved = "AnnotationRemoved", - } + /** + * Represents an action in the annotation pop-up. + * @remarks + * [Api set: WordApi 1.8] + */ + annotationPopupAction = "AnnotationPopupAction", + } /** * An enum that specifies an event's source. It can be local or remote (through coauthoring). * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts index 85b575dded..fa74e62a75 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts @@ -5,19 +5,380 @@ import { Office as Outlook} from "../../api-extractor-inputs-outlook/outlook" //////////////////////////////////////////////////////////////// export declare namespace Word { + /** + * Represents the color scheme of a critique in the document, affecting underline and highlight. + * + * @remarks + * [Api set: WordApi 1.7] + */ + enum CritiqueColorScheme { + /** + * Red color. + * @remarks + * [Api set: WordApi 1.7] + */ + red = "Red", + /** + * Green color. + * @remarks + * [Api set: WordApi 1.7] + */ + green = "Green", + /** + * Blue color. + * @remarks + * [Api set: WordApi 1.7] + */ + blue = "Blue", + /** + * Lavender color. + * @remarks + * [Api set: WordApi 1.7] + */ + lavender = "Lavender", + /** + * Berry color. + * @remarks + * [Api set: WordApi 1.7] + */ + berry = "Berry", + } - - - - - - - - - - - + /** + * Critique that will be rendered as underline for the specified part of paragraph in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface Critique { + /** + * Specifies the color scheme of the critique. + * + * @remarks + * [Api set: WordApi 1.7] + */ + colorScheme: Word.CritiqueColorScheme | "Red" | "Green" | "Blue" | "Lavender" | "Berry"; + /** + * Specifies the length of the critique inside paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + length: number; + + /** + * Specifies the start index of the critique inside paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + start: number; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export class CritiqueAnnotation 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 range of text that is annotated. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly range: Word.Range; + /** + * Gets the critique that was passed when the annotation was inserted. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly critique: Word.Critique; + /** + * Accepts the critique. This will change the annotation state to `accepted`. + * + * @remarks + * [Api set: WordApi 1.7] + */ + accept(): void; + /** + * Rejects the critique. This will change the annotation state to `rejected`. + * + * @remarks + * [Api set: WordApi 1.7] + */ + reject(): 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.CritiqueAnnotationLoadOptions): Word.CritiqueAnnotation; + /** + * 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.CritiqueAnnotation; + /** + * 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.CritiqueAnnotation; + /** + * 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.CritiqueAnnotation; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CritiqueAnnotationData; + } + /** + * Represents the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + enum AnnotationState { + /** + * Created. + * @remarks + * [Api set: WordApi 1.7] + */ + created = "Created", + /** + * Accepted. + * @remarks + * [Api set: WordApi 1.7] + */ + accepted = "Accepted", + /** + * Rejected. + * @remarks + * [Api set: WordApi 1.7] + */ + rejected = "Rejected", + } + /** + * Annotations set produced by the add-in. Currently supporting only critiques. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationSet { + /** + * Critiques. + * + * @remarks + * [Api set: WordApi 1.7] + */ + critiques: Word.Critique[]; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export class Annotation 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 critique annotation object. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly critiqueAnnotation: Word.CritiqueAnnotation; + /** + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly id: string; + /** + * Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly state: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; + /** + * Deletes the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + delete(): 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.AnnotationLoadOptions): Word.Annotation; + /** + * 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.Annotation; + /** + * 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.Annotation; + /** + * 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.Annotation; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.AnnotationData; + } + /** + * Holds annotation information that is passed back on annotation added event. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationInsertedEventArgs { + /** + * Specifies the annotation IDs for which the event was fired. + * + * @remarks + * [Api set: WordApi 1.7] + */ + ids: string[]; + } + /** + * Holds annotation information that is passed back on annotation inserted event. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationClickedEventArgs { + /** + * Specifies the annotation ID for which the event was fired. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id: string; + } + /** + * Holds annotation information that is passed back on annotation removed event. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationRemovedEventArgs { + /** + * Specifies the annotation IDs for which the event was fired. + * + * @remarks + * [Api set: WordApi 1.7] + */ + ids: string[]; + } + /** + * Holds annotation information that is passed back on annotation hovered event. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationHoveredEventArgs { + /** + * Specifies the annotation ID for which the event was fired. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id: string; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export class AnnotationCollection 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.Annotation[]; + /** + * Gets the first annotation in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.7] + */ + getFirst(): Word.Annotation; + /** + * Gets the first annotation 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 1.7] + */ + getFirstOrNullObject(): Word.Annotation; + /** + * 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.AnnotationCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.AnnotationCollection; + /** + * 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.AnnotationCollection; + /** + * 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.AnnotationCollection; + /** + * 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.AnnotationCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.AnnotationCollectionData; + } /** * Represents the application object. * @@ -416,35 +777,96 @@ export declare namespace Word { matchWildcards?: boolean; }): Word.RangeCollection; /** - * Selects the body and navigates the Word UI to it. + * Selects the body and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the body and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): 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.BodyLoadOptions): Word.Body; + /** + * 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.Body; + /** + * 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.Body; + /** + * 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.Body; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.BodyData; + } + + + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export class CheckboxContentControl 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; + /** + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi 1.7] */ - select(selectionMode?: Word.SelectionMode): void; + isChecked: boolean; /** - * Selects the body and navigates the Word UI to it. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * 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. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + set(properties: Interfaces.CheckboxContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CheckboxContentControl): 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.BodyLoadOptions): Word.Body; + load(options?: Word.Interfaces.CheckboxContentControlLoadOptions): Word.CheckboxContentControl; /** * 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.Body; + load(propertyNames?: string | string[]): Word.CheckboxContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -453,24 +875,21 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Body; + }): Word.CheckboxContentControl; /** * 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.Body; + track(): Word.CheckboxContentControl; /** * 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.Body; + 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.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. + * 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.BodyData; + toJSON(): Word.Interfaces.CheckboxContentControlData; } - - - /** * Represents a comment in the document. * @@ -942,7 +1361,13 @@ export declare namespace Word { export class ContentControl 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 data of the content control when its type is `CheckBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + readonly checkboxContentControl: Word.CheckboxContentControl; /** * Gets the collection of content control objects in the content control. @@ -2351,7 +2776,15 @@ export declare namespace Word { * @param name - Required. The case-insensitive bookmark name. */ deleteBookmark(name: string): void; - + /** + * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param id - The ID of the annotation to get. + */ + getAnnotationById(id: string): Word.Annotation; /** * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. * @@ -2470,7 +2903,22 @@ export declare namespace Word { * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. */ save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; - /** + /** + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** * 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. @@ -2491,11 +2939,43 @@ export declare namespace Word { select?: string; expand?: string; }): Word.Document; + /** + * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty + */ + readonly onAnnotationClicked: OfficeExtension.EventHandlers; + /** + * Occurs when the user hovers the cursor over an annotation. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty + */ + readonly onAnnotationHovered: OfficeExtension.EventHandlers; + /** + * Occurs when the user adds one or more annotations. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty + */ + readonly onAnnotationInserted: OfficeExtension.EventHandlers; - - - - + /** + * Occurs when the user deletes one or more annotations. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty + */ + readonly onAnnotationRemoved: OfficeExtension.EventHandlers; /** * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. * @@ -4492,7 +4972,15 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ detachFromList(): void; - + /** + * Gets annotations set on this Paragraph object. + * + * @remarks + * [Api set: WordApi 1.7] + * + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + */ + getAnnotations(): Word.AnnotationCollection; /** * Gets comments associated with the paragraph. * @@ -4582,7 +5070,20 @@ export declare namespace Word { * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; - /** + /** + * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). + By default, hidden text and text marked as deleted are excluded. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param options - Optional. Options that define whether the final result should include hidden text and text marked as deleted. + */ + getText(options?: Word.GetTextOptions | { + IncludeHiddenText?: boolean; + IncludeTextMarkedAsDeleted?: boolean; + }): OfficeExtension.ClientResult; + /** * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. * * @remarks @@ -4599,7 +5100,18 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; - + /** + * Inserts annotations on this Paragraph object. + * + * @remarks + * [Api set: WordApi 1.7] + * + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + * + * @param annotations - Annotations to set. + * @returns An array of the inserted annotations identifiers. + */ + insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; /** * Inserts a break at the specified location in the main document. * @@ -5695,7 +6207,13 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ importCustomXmlParts?: boolean; - + /** + * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + importDifferentOddEvenPages?: boolean; /** * Represents whether the page color and other background information from the source document should be imported. * @@ -5823,7 +6341,28 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.SearchOptionsData; } - + /** + * Specifies the options to be included in a getText operation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface GetTextOptions { + /** + * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. + * + * @remarks + * [Api set: WordApi 1.7] + */ + includeHiddenText?: boolean; + /** + * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. + * + * @remarks + * [Api set: WordApi 1.7] + */ + includeTextMarkedAsDeleted?: boolean; + } /** * Represents a section in a Word document. @@ -8228,7 +8767,31 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ paragraphDeleted = "ParagraphDeleted", - } + /** + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationClicked = "AnnotationClicked", + /** + * Represents that an annotation was hovered over in the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationHovered = "AnnotationHovered", + /** + * Represents that one or more annotations were added in the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationInserted = "AnnotationInserted", + /** + * Represents that one or more annotations were deleted from the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationRemoved = "AnnotationRemoved", + } /** * An enum that specifies an event's source. It can be local or remote (through coauthoring). * @@ -11073,7 +11636,13 @@ export declare namespace Word { } /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ export interface CheckboxContentControlUpdateData { - + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; } /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ export interface CommentUpdateData { @@ -11171,7 +11740,13 @@ 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] + */ + 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. * @@ -12402,12 +12977,30 @@ export declare namespace Word { } /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ export interface CritiqueAnnotationData { - + /** + * Gets the critique that was passed when the annotation was inserted. + * + * @remarks + * [Api set: WordApi 1.7] + */ + critique?: Word.Critique; } /** An interface describing the data returned by calling `annotation.toJSON()`. */ export interface AnnotationData { - - + /** + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id?: string; + /** + * Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; } /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ export interface AnnotationCollectionData { @@ -12510,7 +13103,13 @@ export declare namespace Word { } /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ export interface CheckboxContentControlData { - + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; } /** An interface describing the data returned by calling `comment.toJSON()`. */ export interface CommentData { @@ -12685,7 +13284,13 @@ 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] + */ + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** * Gets the collection of content control objects in the content control. @@ -14502,9 +15107,98 @@ export declare namespace Word { } - - - + /** + * 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 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. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id?: boolean; + /** + * Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationCollectionLoadOptions { + /** + 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: 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. + * + * @remarks + * [Api set: WordApi 1.7] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the state of the annotation. + * + * @remarks + * [Api set: WordApi 1.7] + */ + state?: boolean; + } /** * Represents the body of a document or a section. * @@ -14596,7 +15290,25 @@ export declare namespace Word { } - + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CheckboxContentControlLoadOptions { + /** + 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; + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } /** * Represents a comment in the document. * @@ -14911,7 +15623,13 @@ export declare namespace Word { 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 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. * @@ -15078,7 +15796,13 @@ export declare namespace Word { 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: 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. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts new file mode 100644 index 0000000000..85b575dded --- /dev/null +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts @@ -0,0 +1,18359 @@ +import { OfficeExtension } from "../../api-extractor-inputs-office/office" +import { Office as Outlook} from "../../api-extractor-inputs-outlook/outlook" +//////////////////////////////////////////////////////////////// +/////////////////////// Begin Word APIs //////////////////////// +//////////////////////////////////////////////////////////////// + +export declare namespace Word { + + + + + + + + + + + + + + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class Application 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; + /** + * Creates a new document by using an optional Base64-encoded .docx file. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param base64File - Optional. The Base64-encoded .docx file. The default value is null. + */ + createDocument(base64File?: string): Word.DocumentCreated; + /** + * Opens a document and displays it in a new tab or window. + The following are examples for the various supported clients and platforms. + + - Remote or cloud location example: `https://microsoft.sharepoint.com/some/path/Document.docx` + + - Local location examples for Windows: `C:\\Users\\Someone\\Documents\\Document.docx` (includes required escaped backslashes), `file://mycomputer/myfolder/Document.docx` + + - Local location example for Mac and iOS: `/User/someone/document.docx` + * + * @remarks + * [Api set: WordApi 1.6] + * + * @param filePath - Required. The absolute path of the .docx file. Word on the web only supports remote (cloud) locations, while Word on Windows, on Mac, and on iOS support local and remote locations. + */ + openDocument(filePath: string): void; + /** + * Parse styles from template Base64 file and return JSON format of retrieved styles as a string. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param base64File - Required. The template file. + */ + retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult; + /** + * Create a new instance of the `Word.Application` object. + */ + 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. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Body 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 collection of rich text content control objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the body. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of field objects in the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * 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] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the body. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * Gets the collection of list objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lists: Word.ListCollection; + /** + * 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. + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * 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] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentBodyOrNullObject: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentSection: Word.Section; + /** + * 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] + */ + readonly parentSectionOrNullObject: Word.Section; + + /** + * Gets the collection of table objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly tables: Word.TableCollection; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly text: string; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly type: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + /** + * 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.BodyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Body): void; + /** + * Clears the contents of the body object. The user can perform the undo operation on the cleared content. + * + * @remarks + * [Api set: WordApi 1.1] + */ + clear(): void; + /** + * Gets comments associated with the body. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getComments(): Word.CommentCollection; + /** + * Gets the currently supported content controls in the body. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets an HTML representation of the body object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Body.getOoxml()` and convert the returned XML to HTML. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getHtml(): OfficeExtension.ClientResult; + /** + * Gets the OOXML (Office Open XML) representation of the body object. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getOoxml(): OfficeExtension.ClientResult; + /** + * Gets the whole body, or the starting or ending point of the body, as a range. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + /** + * Gets the collection of the TrackedChange objects in the body. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getTrackedChanges(): Word.TrackedChangeCollection; + /** + * Inserts a break at the specified location in the main document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param breakType - Required. The break type to add to the body. + * @param insertLocation - Required. The value must be 'Start' or 'End'. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): void; + /** + * Wraps the Body object with a content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * + * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + */ + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + /** + * Inserts a document into the body at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * 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'. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts HTML at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param html - Required. The HTML to be inserted in the document. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a picture into the body at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted in the body. + * @param insertLocation - Required. The value must be 'Start' or 'End'. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.InlinePicture; + /** + * Inserts OOXML at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param ooxml - Required. The OOXML to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Start' or 'End'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Start' or 'End'. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", values?: string[][]): Word.Table; + /** + * Inserts text into the body at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param text - Required. Text to be inserted. + * @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; + /** + * Performs a search with the specified SearchOptions on the scope of the body object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. Can be a maximum of 255 characters. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects the body and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the body and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): 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.BodyLoadOptions): Word.Body; + /** + * 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.Body; + /** + * 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.Body; + /** + * 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.Body; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.BodyData; + } + + + + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class Comment 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; + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange: Word.CommentContentRange; + /** + * Gets the collection of reply objects associated with the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly replies: Word.CommentReplyCollection; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorName: string; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content: string; + /** + * Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly creationDate: Date; + /** + * Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly id: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved: boolean; + /** + * 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.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Comment): void; + /** + * Deletes the comment and its replies. + * + * @remarks + * [Api set: WordApi 1.4] + */ + delete(): void; + /** + * Gets the range in the main document where the comment is on. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getRange(): Word.Range; + /** + * Adds a new reply to the end of the comment thread. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param replyText - Required. Reply text. + */ + reply(replyText: string): Word.CommentReply; + /** + * 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.CommentLoadOptions): Word.Comment; + /** + * 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.Comment; + /** + * 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.Comment; + /** + * 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.Comment; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CommentData; + } + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CommentCollection 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.Comment[]; + /** + * Gets the first comment in the collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getFirst(): Word.Comment; + /** + * Gets the first comment in the collection. If the 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 1.4] + */ + getFirstOrNullObject(): Word.Comment; + /** + * 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.CommentCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentCollection; + /** + * 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.CommentCollection; + /** + * 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.CommentCollection; + /** + * 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.CommentCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CommentCollectionData; + } + /** + * @remarks + * [Api set: WordApi 1.4] + */ + export class CommentContentRange 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; + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly isEmpty: boolean; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly text: string; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * 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.CommentContentRangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CommentContentRange): void; + /** + * Inserts text into at the specified location. **Note**: For the modern comment, the content range tracked across context turns to empty if any revision to the comment is posted through the UI. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param text - Required. The text to be inserted in to the CommentContentRange. + * @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.CommentContentRange; + /** + * 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.CommentContentRangeLoadOptions): Word.CommentContentRange; + /** + * 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.CommentContentRange; + /** + * 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.CommentContentRange; + /** + * 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.CommentContentRange; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CommentContentRangeData; + } + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CommentReply 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; + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange: Word.CommentContentRange; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly parentComment: Word.Comment; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorEmail: string; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly authorName: string; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content: string; + /** + * Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly creationDate: Date; + /** + * Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly id: string; + /** + * 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.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CommentReply): void; + /** + * Deletes the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + delete(): 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.CommentReplyLoadOptions): Word.CommentReply; + /** + * 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.CommentReply; + /** + * 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.CommentReply; + /** + * 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.CommentReply; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CommentReplyData; + } + /** + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CommentReplyCollection 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.CommentReply[]; + /** + * Gets the first comment reply in the collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getFirst(): Word.CommentReply; + /** + * Gets the first comment reply in the collection. If the 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 1.4] + */ + getFirstOrNullObject(): Word.CommentReply; + /** + * 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.CommentReplyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CommentReplyCollection; + /** + * 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.CommentReplyCollection; + /** + * 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.CommentReplyCollection; + /** + * 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.CommentReplyCollection; + /** + * 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.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. + */ + 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, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class ContentControl 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 collection of content control objects in the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + + /** + * Gets the collection of endnotes in the content control. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of field objects in the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * 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] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the content control. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * Gets the collection of list objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lists: Word.ListCollection; + /** + * 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. + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of table objects in the content control. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly tables: Word.TableCollection; + /** + * 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] + */ + cannotEdit: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color: string; + /** + * Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly id: number; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag: string; + /** + * Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly text: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title: string; + /** + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + /** + * 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.ContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ContentControl): void; + /** + * Clears the contents of the content control. The user can perform the undo operation on the cleared content. + * + * @remarks + * [Api set: WordApi 1.1] + */ + clear(): void; + /** + * Deletes the content control and its content. If `keepContent` is set to true, the content isn't deleted. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param keepContent - Required. Indicates whether the content should be deleted with the content control. If `keepContent` is set to true, the content isn't deleted. + */ + delete(keepContent: boolean): void; + /** + * Gets comments associated with the content control. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getComments(): Word.CommentCollection; + /** + * Gets the currently supported child content controls in this content control. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets an HTML representation of the content control object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `ContentControl.getOoxml()` and convert the returned XML to HTML. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getHtml(): OfficeExtension.ClientResult; + /** + * Gets the Office Open XML (OOXML) representation of the content control object. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getOoxml(): OfficeExtension.ClientResult; + /** + * Gets the whole content control, or the starting or ending point of the content control, as a range. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'Before', 'After', or 'Content'. + */ + getRange(rangeLocation?: Word.RangeLocation | "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + /** + * Gets the text ranges in the content control by using punctuation marks and/or other ending marks. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + /** + * Gets the collection of the TrackedChange objects in the content control. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getTrackedChanges(): Word.TrackedChangeCollection; + /** + * Inserts a break at the specified location in the main document. This method cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param breakType - Required. Type of break. + * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): void; + /** + * Inserts a document into the content control at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * 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. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts HTML into the content control at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param html - Required. The HTML to be inserted in to the content control. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts an inline picture into the content control at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted in the content control. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + /** + * Inserts OOXML into the content control at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param ooxml - Required. The OOXML to be inserted in to the content control. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns into, or next to, a content control. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. 'Before' and 'After' cannot be used with 'RichTextTable', 'RichTextTableRow' and 'RichTextTableCell' content controls. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After", values?: string[][]): Word.Table; + /** + * Inserts text into the content control at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param text - Required. The text to be inserted in to the content control. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. 'Replace' cannot be used with 'RichTextTable' and 'RichTextTableRow' content controls. + */ + insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Performs a search with the specified SearchOptions on the scope of the content control object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects the content control. This causes Word to scroll to the selection. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the content control. This causes Word to scroll to the selection. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Splits the content control into child ranges by using delimiters. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param delimiters - Required. The delimiters as an array of strings. + * @param multiParagraphs - Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + /** + * 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.ContentControlLoadOptions): Word.ContentControl; + /** + * 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.ContentControl; + /** + * 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.ContentControl; + /** + * Occurs when data within the content control are changed. To get the new text, load this content control in the handler. To get the old text, do not load it. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onDataChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the content control is deleted. Do not load this content control in the handler, otherwise you won't be able to get its original properties. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onDeleted: OfficeExtension.EventHandlers; + /** + * Occurs when the content control is entered. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onEntered: OfficeExtension.EventHandlers; + /** + * Occurs when the content control is exited, for example, when the cursor leaves the content control. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onExited: OfficeExtension.EventHandlers; + /** + * Occurs when selection within the content control is changed. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * 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.ContentControl; + /** + * 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.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. + */ + 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, plain text, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class ContentControlCollection 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.ContentControl[]; + /** + * Gets the content controls that have the specified tracking state. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param changeTrackingStates - Required. An array of content control change tracking states. + */ + getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[]): Word.ContentControlCollection; + /** + * Gets a content control by its identifier. Throws an `ItemNotFound` error if there isn't a content control with the identifier in this collection. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param id - Required. A content control identifier. + */ + getById(id: number): Word.ContentControl; + /** + * Gets a content control by its identifier. If there isn't a content control 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 1.3] + * + * @param id - Required. A content control identifier. + */ + getByIdOrNullObject(id: number): Word.ContentControl; + /** + * Gets the content controls that have the specified tag. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param tag - Required. A tag set on a content control. + */ + getByTag(tag: string): Word.ContentControlCollection; + /** + * Gets the content controls that have the specified title. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param title - Required. The title of a content control. + */ + getByTitle(title: string): Word.ContentControlCollection; + /** + * Gets the content controls that have the specified types. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param types - Required. An array of content control types. + */ + getByTypes(types: Word.ContentControlType[]): Word.ContentControlCollection; + /** + * Gets the first content control in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.ContentControl; + /** + * Gets the first content control 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 1.3] + */ + getFirstOrNullObject(): Word.ContentControl; + /** + * Gets a content control by its ID. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param id - The content control's ID. + */ + getItem(id: number): Word.ContentControl; + /** + * 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.ContentControlCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ContentControlCollection; + /** + * 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.ContentControlCollection; + /** + * 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.ContentControlCollection; + /** + * 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.ContentControlCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlCollectionData; + } + + + /** + * Specifies the options that define which content controls are returned. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlOptions { + /** + * An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: 'PlainText' support was added in WordApi 1.5. 'CheckBox' support was added in WordApi 1.7. + * 'DropDownList' and 'ComboBox' support was added in WordApi 1.9. + */ + types: Word.ContentControlType[]; + } + /** + * Represents a custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class CustomProperty 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 key of the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly key: string; + /** + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value: any; + /** + * 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.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CustomProperty): void; + /** + * Deletes the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + delete(): 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.CustomPropertyLoadOptions): Word.CustomProperty; + /** + * 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.CustomProperty; + /** + * 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.CustomProperty; + /** + * 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.CustomProperty; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CustomPropertyData; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class CustomPropertyCollection 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.CustomProperty[]; + /** + * Creates a new or sets an existing custom property. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param key - Required. The custom property's key, which is case-insensitive. + * @param value - Required. The custom property's value. + */ + add(key: string, value: any): Word.CustomProperty; + /** + * Deletes all custom properties in this collection. + * + * @remarks + * [Api set: WordApi 1.3] + */ + deleteAll(): void; + /** + * Gets the count of custom properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom property object by its key, which is case-insensitive. Throws an `ItemNotFound` error if the custom property doesn't exist. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param key - The key that identifies the custom property object. + */ + getItem(key: string): Word.CustomProperty; + /** + * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, 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] + * + * @param key - Required. The key that identifies the custom property object. + */ + getItemOrNullObject(key: string): Word.CustomProperty; + /** + * 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.CustomPropertyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomPropertyCollection; + /** + * 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.CustomPropertyCollection; + /** + * 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.CustomPropertyCollection; + /** + * 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.CustomPropertyCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CustomPropertyCollectionData; + } + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CustomXmlPart 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 ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly id: string; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly namespaceUri: string; + /** + * Deletes the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + delete(): void; + /** + * Deletes an attribute with the given name from the element identified by xpath. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single element in XPath notation. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name - Required. Name of the attribute. + */ + deleteAttribute(xpath: string, namespaceMappings: { + [key: string]: string; + }, name: string): void; + /** + * Deletes the element identified by xpath. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single element in XPath notation. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + */ + deleteElement(xpath: string, namespaceMappings: { + [key: string]: string; + }): void; + /** + * Gets the full XML content of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getXml(): OfficeExtension.ClientResult; + /** + * Inserts an attribute with the given name and value to the element identified by xpath. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single element in XPath notation. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name - Required. Name of the attribute. + * @param value - Required. Value of the attribute. + */ + insertAttribute(xpath: string, namespaceMappings: { + [key: string]: string; + }, name: string, value: string): void; + /** + * Inserts the given XML under the parent element identified by xpath at child position index. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single parent element in XPath notation. + * @param xml - Required. XML content to be inserted. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param index - Optional. Zero-based position at which the new XML to be inserted. If omitted, the XML will be appended as the last child of this parent. + */ + insertElement(xpath: string, xml: string, namespaceMappings: { + [key: string]: string; + }, index?: number): void; + /** + * Queries the XML content of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. An XPath query. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @returns An array where each item represents an entry matched by the XPath query. + */ + query(xpath: string, namespaceMappings: { + [key: string]: string; + }): OfficeExtension.ClientResult; + /** + * Sets the full XML content of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param xml - Required. XML content to be set. + */ + setXml(xml: string): void; + /** + * Updates the value of an attribute with the given name of the element identified by xpath. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single element in XPath notation. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + * @param name - Required. Name of the attribute. + * @param value - Required. New value of the attribute. + */ + updateAttribute(xpath: string, namespaceMappings: { + [key: string]: string; + }, name: string, value: string): void; + /** + * Updates the XML of the element identified by xpath. + * + * @remarks + * [Api set: WordApi 1.4] + * + * If any element in the tree has an xmlns attribute (whose value is typically, but not always, a URI), + * an alias for that attribute value must prefix the element name in the xpath parameter. For example, suppose + * the tree is the following: + * + * ```xml + * + * + * something + * + * + * ``` + * + * The xpath to `` must be \/Day\/greg:Month\/Week, where greg is an alias that is mapped to + * "http:\/\/calendartypes.org\/xsds\/GregorianCalendar" in the namespaceMappings parameter. + * + * @param xpath - Required. Absolute path to the single element in XPath notation. + * @param xml - Required. New XML content to be stored. + * @param namespaceMappings - Required. An object whose property values are namespace names and whose property names are aliases for the corresponding namespaces. For example, `{greg: "http://calendartypes.org/xsds/GregorianCalendar"}`. The property names (such as "greg") can be any string that doesn't used reserved XPath characters, such as the forward slash "/". + */ + updateElement(xpath: string, xml: string, namespaceMappings: { + [key: string]: string; + }): 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.CustomXmlPartLoadOptions): Word.CustomXmlPart; + /** + * 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.CustomXmlPart; + /** + * 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.CustomXmlPart; + /** + * 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.CustomXmlPart; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CustomXmlPartData; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CustomXmlPartCollection 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.CustomXmlPart[]; + /** + * Adds a new custom XML part to the document. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param xml - Required. XML content. Must be a valid XML fragment. + */ + add(xml: string): Word.CustomXmlPart; + /** + * Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param namespaceUri - Required. The namespace URI. + */ + getByNamespace(namespaceUri: string): Word.CustomXmlPartScopedCollection; + /** + * Gets the number of items in the collection. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom XML part based on its ID. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param id - ID or index of the custom XML part to be retrieved. + */ + getItem(id: string): Word.CustomXmlPart; + /** + * Gets a custom XML part based on its ID. If the CustomXmlPart doesn't exist, 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] + * + * @param id - Required. ID of the object to be retrieved. + */ + getItemOrNullObject(id: string): Word.CustomXmlPart; + /** + * 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.CustomXmlPartCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPartCollection; + /** + * 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.CustomXmlPartCollection; + /** + * 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.CustomXmlPartCollection; + /** + * 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.CustomXmlPartCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CustomXmlPartCollectionData; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class CustomXmlPartScopedCollection 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.CustomXmlPart[]; + /** + * Gets the number of items in the collection. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a custom XML part based on its ID. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param id - ID of the custom XML part to be retrieved. + */ + getItem(id: string): Word.CustomXmlPart; + /** + * Gets a custom XML part based on its ID. If the CustomXmlPart doesn't exist in the 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 1.4] + * + * @param id - Required. ID of the object to be retrieved. + */ + getItemOrNullObject(id: string): Word.CustomXmlPart; + /** + * If the collection contains exactly one item, this method returns it. Otherwise, this method produces an error. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getOnlyItem(): Word.CustomXmlPart; + /** + * If the collection contains exactly one item, this method returns it. Otherwise, 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] + */ + getOnlyItemOrNullObject(): Word.CustomXmlPart; + /** + * 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.CustomXmlPartScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPartScopedCollection; + /** + * 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.CustomXmlPartScopedCollection; + /** + * 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.CustomXmlPartScopedCollection; + /** + * 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.CustomXmlPartScopedCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData; + } + /** + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Document 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 body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly body: Word.Body; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly customXmlParts: Word.CustomXmlPartCollection; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly properties: Word.DocumentProperties; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly sections: Word.SectionCollection; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly settings: Word.SettingCollection; + + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly saved: boolean; + /** + * 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.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Document): void; + /** + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. + */ + addStyle(name: string, type: Word.StyleType): Word.Style; + /** + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. + */ + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + /** + * Closes the current document. + + Note: This API isn't supported in Word on the web. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + */ + close(closeBehavior?: Word.CloseBehavior): void; + /** + * Closes the current document. + + Note: This API isn't supported in Word on the web. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + */ + close(closeBehavior?: "Save" | "SkipSave"): void; + + + /** + * Deletes a bookmark, if it exists, from the document. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param name - Required. The case-insensitive bookmark name. + */ + deleteBookmark(name: string): void; + + /** + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param name - Required. The case-insensitive bookmark name. + */ + getBookmarkRange(name: string): Word.Range; + /** + * Gets a bookmark's range. If the bookmark doesn't exist, 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] + * + * @param name - Required. The case-insensitive bookmark name. + */ + getBookmarkRangeOrNullObject(name: string): Word.Range; + /** + * Gets the currently supported content controls in the document. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets the document's endnotes in a single body. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getEndnoteBody(): Word.Body; + /** + * Gets the document's footnotes in a single body. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getFootnoteBody(): Word.Body; + /** + * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @param id - Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + */ + getParagraphByUniqueLocalId(id: string): Word.Paragraph; + /** + * Gets the current selection of the document. Multiple selections aren't supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getSelection(): Word.Range; + /** + * Gets a StyleCollection object that represents the whole style set of the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getStyles(): Word.StyleCollection; + /** + * Import styles from a JSON-formatted string. + * + * @remarks + * [Api set: WordApi 1.6] + * + * + * + * @param stylesJson - Required. A JSON-formatted string representing the styles. + * + */ + importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult; + /** + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. + * + * @remarks + * [Api set: WordApi 1.5] + * + * 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'. + * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + /** + * Saves the document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + /** + * Saves the document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: "Save" | "Prompt", fileName?: string): 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.DocumentLoadOptions): Word.Document; + /** + * 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.Document; + /** + * 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.Document; + + + + + + /** + * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty + */ + readonly onContentControlAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the user adds new paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the user changes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the user deletes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphDeleted: OfficeExtension.EventHandlers; + /** + * 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.Document; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DocumentData; + } + /** + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class DocumentCreated 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 body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + readonly body: Word.Body; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + readonly customXmlParts: Word.CustomXmlPartCollection; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + readonly properties: Word.DocumentProperties; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + readonly sections: Word.SectionCollection; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + readonly settings: Word.SettingCollection; + /** + * 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. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + readonly saved: boolean; + /** + * 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.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentCreated): void; + /** + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. + */ + addStyle(name: string, type: Word.StyleType): Word.Style; + /** + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. + */ + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + /** + * Deletes a bookmark, if it exists, from the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name - Required. The case-insensitive bookmark name. + */ + deleteBookmark(name: string): void; + /** + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name - Required. The case-insensitive bookmark name. + */ + getBookmarkRange(name: string): Word.Range; + /** + * Gets a bookmark's range. If the bookmark doesn't exist, 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: WordApiHiddenDocument 1.4] + * + * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + */ + getBookmarkRangeOrNullObject(name: string): Word.Range; + /** + * Gets the currently supported content controls in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets a StyleCollection object that represents the whole style set of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + */ + getStyles(): Word.StyleCollection; + /** + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * 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'. + * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + /** + * Opens the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + open(): void; + /** + * Saves the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + /** + * Saves the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: "Save" | "Prompt", fileName?: string): 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.DocumentCreatedLoadOptions): Word.DocumentCreated; + /** + * 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.DocumentCreated; + /** + * 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.DocumentCreated; + /** + * 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.DocumentCreated; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DocumentCreatedData; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class DocumentProperties 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 collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly customProperties: Word.CustomPropertyCollection; + /** + * Gets the application name of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly applicationName: string; + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company: string; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly creationDate: Date; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords: string; + /** + * Gets the last author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lastAuthor: string; + /** + * Gets the last print date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lastPrintDate: Date; + /** + * Gets the last save time of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lastSaveTime: Date; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager: string; + /** + * Gets the revision number of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly revisionNumber: string; + /** + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly security: number; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject: string; + /** + * Gets the template of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly template: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title: string; + /** + * 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.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentProperties): 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.DocumentPropertiesLoadOptions): Word.DocumentProperties; + /** + * 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.DocumentProperties; + /** + * 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.DocumentProperties; + /** + * 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.DocumentProperties; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DocumentPropertiesData; + } + + + /** + * Represents a field. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export class Field 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 parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly result: Word.Range; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data: string; + /** + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked: boolean; + + /** + * Gets the field's type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + /** + * 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.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Field): void; + /** + * Deletes the field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + delete(): void; + /** + * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getNext(): Word.Field; + /** + * Gets the next field. If this field is the last one, 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] + */ + getNextOrNullObject(): Word.Field; + /** + * Selects the field. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the field. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Updates the field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + updateResult(): 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.FieldLoadOptions): Word.Field; + /** + * 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.Field; + /** + * 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.Field; + /** + * 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.Field; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.FieldData; + } + /** + * Contains a collection of {@link Word.Field} objects. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export class FieldCollection 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.Field[]; + /** + * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getFirst(): Word.Field; + /** + * Gets the first field 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 1.4] + */ + getFirstOrNullObject(): Word.Field; + /** + * Gets the Field object collection including the specified types of fields. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param types - Required. An array of field types. + */ + getByTypes(types: Word.FieldType[]): Word.FieldCollection; + /** + * 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.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; + /** + * 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.FieldCollection; + /** + * 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.FieldCollection; + /** + * 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.FieldCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.FieldCollectionData; + } + /** + * Represents a font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Font 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; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color: string; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough: boolean; + + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic: boolean; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name: string; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough: boolean; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * 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.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Font): 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.FontLoadOptions): Word.Font; + /** + * 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.Font; + /** + * 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.Font; + /** + * 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.Font; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.FontData; + } + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class InlinePicture 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 parent paragraph that contains the inline image. + * + * @remarks + * [Api set: WordApi 1.2] + */ + readonly paragraph: Word.Paragraph; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink: string; + + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + 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.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.InlinePicture): void; + /** + * Deletes the inline picture from the document. + * + * @remarks + * [Api set: WordApi 1.2] + */ + delete(): void; + /** + * Gets the Base64-encoded string representation of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getBase64ImageSrc(): OfficeExtension.ClientResult; + /** + * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.InlinePicture; + /** + * Gets the next inline image. If this inline image is the last one, 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] + */ + getNextOrNullObject(): Word.InlinePicture; + /** + * Gets the picture, or the starting or ending point of the picture, as a range. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', or 'End'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + /** + * Inserts a break at the specified location in the main document. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param breakType - Required. The break type to add. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + /** + * Wraps the inline picture with a rich text content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + insertContentControl(): Word.ContentControl; + /** + * Inserts a document at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * 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'. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + /** + * Inserts HTML at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param html - Required. The HTML to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + /** + * Inserts an inline picture at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Before', or 'After'. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; + /** + * Inserts OOXML at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param ooxml - Required. The OOXML to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts text at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param text - Required. Text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + /** + * Selects the inline picture. This causes Word to scroll to the selection. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the inline picture. This causes Word to scroll to the selection. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): 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.InlinePictureLoadOptions): Word.InlinePicture; + /** + * 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.InlinePicture; + /** + * 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.InlinePicture; + /** + * 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.InlinePicture; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.InlinePictureData; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class InlinePictureCollection 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.InlinePicture[]; + /** + * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.InlinePicture; + /** + * Gets the first inline image 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 1.3] + */ + getFirstOrNullObject(): Word.InlinePicture; + /** + * 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.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; + /** + * 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.InlinePictureCollection; + /** + * 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.InlinePictureCollection; + /** + * 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.InlinePictureCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.InlinePictureCollectionData; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class List 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 paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Gets the list's id. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly id: number; + /** + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly levelExistences: boolean[]; + /** + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly levelTypes: Word.ListLevelType[]; + + /** + * Gets the paragraphs that occur at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + */ + getLevelParagraphs(level: number): Word.ParagraphCollection; + + /** + * Gets the bullet, number, or picture at the specified level as a string. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + */ + getLevelString(level: number): OfficeExtension.ClientResult; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; + + /** + * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + */ + setLevelAlignment(level: number, alignment: Word.Alignment): void; + /** + * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + */ + setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; + /** + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listBullet - Required. The bullet. + * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. + */ + setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; + /** + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listBullet - Required. The bullet. + * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. + */ + setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; + /** + * Sets the two indents of the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param textIndent - Required. The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent - Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. + */ + setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; + /** + * Sets the numbering format at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listNumbering - Required. The ordinal format. + * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + */ + setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; + /** + * Sets the numbering format at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listNumbering - Required. The ordinal format. + * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. + */ + setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; + + /** + * Sets the starting number at the specified level in the list. Default value is 1. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param startingNumber - Required. The number to start with. + */ + setLevelStartingNumber(level: number, startingNumber: number): 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.ListLoadOptions): Word.List; + /** + * 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.List; + /** + * 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.List; + /** + * 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.List; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ListData; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class ListCollection 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.List[]; + /** + * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param id - Required. A list identifier. + */ + getById(id: number): Word.List; + /** + * Gets a list by its identifier. If there isn't a list 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 1.3] + * + * @param id - Required. A list identifier. + */ + getByIdOrNullObject(id: number): Word.List; + /** + * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.List; + /** + * Gets the first list 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 1.3] + */ + getFirstOrNullObject(): Word.List; + /** + * Gets a list object by its ID. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param id - The list's ID. + */ + getItem(id: number): Word.List; + /** + * 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.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; + /** + * 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.ListCollection; + /** + * 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.ListCollection; + /** + * 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.ListCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ListCollectionData; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class ListItem 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; + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level: number; + /** + * Gets the list item bullet, number, or picture as a string. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly listString: string; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly siblingIndex: 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.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListItem): void; + /** + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + */ + getAncestor(parentOnly?: boolean): Word.Paragraph; + /** + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, 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] + * + * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + */ + getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; + /** + * Gets all descendant list items of the list item. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param directChildrenOnly - Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. + */ + getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; + /** + * 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.ListItemLoadOptions): Word.ListItem; + /** + * 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.ListItem; + /** + * 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.ListItem; + /** + * 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.ListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ListItemData; + } + + + + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class NoteItem 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 note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly body: Word.Body; + /** + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly reference: Word.Range; + /** + * Represents the note item type: footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly type: Word.NoteItemType | "Footnote" | "Endnote"; + /** + * 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.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.NoteItem): void; + /** + * Deletes the note item. + * + * @remarks + * [Api set: WordApi 1.5] + */ + delete(): void; + /** + * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getNext(): Word.NoteItem; + /** + * Gets the next note item of the same type. If this note item is the last one, 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.5] + */ + getNextOrNullObject(): Word.NoteItem; + /** + * 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.NoteItemLoadOptions): Word.NoteItem; + /** + * 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.NoteItem; + /** + * 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.NoteItem; + /** + * 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.NoteItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.NoteItemData; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class NoteItemCollection 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.NoteItem[]; + /** + * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getFirst(): Word.NoteItem; + /** + * Gets the first note item 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 1.5] + */ + getFirstOrNullObject(): Word.NoteItem; + /** + * 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.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; + /** + * 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.NoteItemCollection; + /** + * 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.NoteItemCollection; + /** + * 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.NoteItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.NoteItemCollectionData; + } + + + + + + + /** + * Represents a single paragraph in a selection, range, content control, or document body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Paragraph 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 collection of content control objects in the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the paragraph. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of fields in the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * 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] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the paragraph. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * 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] + */ + readonly list: Word.List; + /** + * 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] + */ + readonly listItem: Word.ListItem; + /** + * 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] + */ + readonly listItemOrNullObject: Word.ListItem; + /** + * 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] + */ + readonly listOrNullObject: Word.List; + /** + * Gets the parent body of the paragraph. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent: number; + /** + * Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly isLastParagraph: boolean; + /** + * Checks whether the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly isListItem: boolean; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore: number; + /** + * Specifies the style name for the paragraph. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style: string; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly tableNestingLevel: number; + /** + * Gets the text of the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly text: string; + /** + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly uniqueLocalId: string; + /** + * 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.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Paragraph): void; + /** + * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param listId - Required. The ID of an existing list. + * @param level - Required. The level in the list. + */ + attachToList(listId: number, level: number): Word.List; + /** + * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. + * + * @remarks + * [Api set: WordApi 1.1] + */ + clear(): void; + /** + * Deletes the paragraph and its content from the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + delete(): void; + /** + * Moves this paragraph out of its list, if the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + detachFromList(): void; + + /** + * Gets comments associated with the paragraph. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getComments(): Word.CommentCollection; + /** + * Gets the currently supported content controls in the paragraph. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getHtml(): OfficeExtension.ClientResult; + /** + * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.Paragraph; + /** + * Gets the next paragraph. If the paragraph is the last one, 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] + */ + getNextOrNullObject(): Word.Paragraph; + /** + * Gets the Office Open XML (OOXML) representation of the paragraph object. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getOoxml(): OfficeExtension.ClientResult; + /** + * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getPrevious(): Word.Paragraph; + /** + * Gets the previous paragraph. If the paragraph is the first one, 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] + */ + getPreviousOrNullObject(): Word.Paragraph; + /** + * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + /** + * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + /** + * Gets the collection of the TrackedChange objects in the paragraph. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getTrackedChanges(): Word.TrackedChangeCollection; + + /** + * Inserts a break at the specified location in the main document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param breakType - Required. The break type to add to the document. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + + /** + * Wraps the Paragraph object with a content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * + * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + */ + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + /** + * Inserts a document into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * 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'. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + + + /** + * Inserts HTML into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param html - Required. The HTML to be inserted in the paragraph. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a picture into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + /** + * Inserts OOXML into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param ooxml - Required. The OOXML to be inserted in the paragraph. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Inserts text into the paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param text - Required. Text to be inserted. + * @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; + + /** + * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Splits the paragraph into child ranges by using delimiters. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param delimiters - Required. The delimiters as an array of strings. + * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + /** + * Starts a new list with this paragraph. Fails if the paragraph is already a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + startNewList(): Word.List; + /** + * 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.ParagraphLoadOptions): Word.Paragraph; + /** + * 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.Paragraph; + /** + * 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.Paragraph; + /** + * 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.Paragraph; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ParagraphData; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class ParagraphCollection 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.Paragraph[]; + /** + * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.Paragraph; + /** + * Gets the first paragraph in this collection. If the 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 1.3] + */ + getFirstOrNullObject(): Word.Paragraph; + /** + * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getLast(): Word.Paragraph; + /** + * Gets the last paragraph in this collection. If the 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 1.3] + */ + getLastOrNullObject(): Word.Paragraph; + /** + * 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.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; + /** + * 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.ParagraphCollection; + /** + * 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.ParagraphCollection; + /** + * 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.ParagraphCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ParagraphCollectionData; + } + /** + * Represents a style of paragraph in a document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class ParagraphFormat 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; + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent: number; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl: boolean; + /** + * 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.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ParagraphFormat): 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.ParagraphFormatLoadOptions): Word.ParagraphFormat; + /** + * 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.ParagraphFormat; + /** + * 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.ParagraphFormat; + /** + * 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.ParagraphFormat; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ParagraphFormatData; + } + /** + * Represents a contiguous area in a document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Range 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 collection of content control objects in the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the range. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of field objects in the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * 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] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the range. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the collection of inline picture objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ + readonly inlinePictures: Word.InlinePictureCollection; + /** + * Gets the collection of list objects in the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly lists: Word.ListCollection; + + /** + * Gets the collection of paragraph objects in the range. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Gets the parent body of the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + + /** + * Gets the collection of table objects in the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly tables: Word.TableCollection; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly isEmpty: boolean; + /** + * Specifies the style name for the range. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style: string; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly text: string; + /** + * 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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Range): void; + /** + * Clears the contents of the range object. The user can perform the undo operation on the cleared content. + * + * @remarks + * [Api set: WordApi 1.1] + */ + clear(): void; + /** + * Compares this range's location with another range's location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param range - Required. The range to compare with this range. + */ + compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; + /** + * Deletes the range and its content from the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + 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 don't have a union. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param range - Required. Another range. + */ + expandTo(range: Word.Range): Word.Range; + /** + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, 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] + * + * @param range - Required. Another range. + */ + expandToOrNullObject(range: Word.Range): Word.Range; + /** + * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param includeHidden - Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent - Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. + */ + getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; + /** + * Gets comments associated with the range. + * + * @remarks + * [Api set: WordApi 1.4] + * @returns + */ + getComments(): Word.CommentCollection; + /** + * Gets the currently supported content controls in the range. + * + * @remarks + * [Api set: WordApi 1.5] + * + * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. + */ + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + /** + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getHtml(): OfficeExtension.ClientResult; + /** + * Gets hyperlink child ranges within the range. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getHyperlinkRanges(): Word.RangeCollection; + /** + * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + */ + getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; + /** + * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, 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] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + */ + getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; + /** + * Gets the OOXML representation of the range object. + * + * @remarks + * [Api set: WordApi 1.1] + */ + getOoxml(): OfficeExtension.ClientResult; + /** + * Clones the range, or gets the starting or ending point of the range as a new range. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + /** + * Gets reviewed text based on ChangeTrackingVersion selection. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + */ + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + /** + * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + /** + * Gets the collection of the TrackedChange objects in the range. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getTrackedChanges(): Word.TrackedChangeCollection; + + /** + * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * + * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + */ + insertBookmark(name: string): void; + /** + * Inserts a break at the specified location in the main document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param breakType - Required. The break type to add. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + + /** + * Insert a comment on the range. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param commentText - Required. The comment text to be inserted. + * @returns comment object + */ + insertComment(commentText: string): Word.Comment; + /** + * Wraps the Range object with a content control. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * + * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + */ + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + /** + * Inserts an endnote. The endnote reference is placed after the range. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param insertText - Optional. Text to be inserted into the endnote body. The default is "". + */ + insertEndnote(insertText?: string): Word.NoteItem; + /** + * Inserts a field at the specified location. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. + * @param text - Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + */ + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; + /** + * Inserts a field at the specified location. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. + * @param text - Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + */ + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; + /** + * Inserts a document at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * 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'. + */ + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + /** + * Inserts a footnote. The footnote reference is placed after the range. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param insertText - Optional. Text to be inserted into the footnote body. The default is "". + */ + insertFootnote(insertText?: string): Word.NoteItem; + + + /** + * Inserts HTML at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param html - Required. The HTML to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + */ + insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + /** + * Inserts a picture at the specified location. + * + * @remarks + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + */ + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; + /** + * Inserts OOXML at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param ooxml - Required. The OOXML to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + */ + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Inserts text at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param text - Required. Text to be inserted. + * @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; + + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param range - Required. Another range. + */ + intersectWith(range: Word.Range): Word.Range; + /** + * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, 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] + * + * @param range - Required. Another range. + */ + intersectWithOrNullObject(range: Word.Range): Word.Range; + + /** + * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects and navigates the Word UI to the range. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects and navigates the Word UI to the range. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Splits the range into child ranges by using delimiters. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param delimiters - Required. The delimiters as an array of strings. + * @param multiParagraphs - Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + /** + * 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.RangeLoadOptions): Word.Range; + /** + * 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.Range; + /** + * 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.Range; + /** + * 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.Range; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeData; + } + /** + * Contains a collection of {@link Word.Range} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class RangeCollection 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.Range[]; + /** + * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.Range; + /** + * Gets the first range 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 1.3] + */ + getFirstOrNullObject(): Word.Range; + /** + * 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.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; + /** + * 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.RangeCollection; + /** + * 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.RangeCollection; + /** + * 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.RangeCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeCollectionData; + } + + /** + * Specifies the options to determine what to copy when inserting a file. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface InsertFileOptions { + /** + * Represents whether the change tracking mode status from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.5] + */ + importChangeTrackingMode?: boolean; + /** + * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + importCustomProperties?: boolean; + /** + * Represents whether the custom XML parts from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.6] + */ + importCustomXmlParts?: boolean; + + /** + * Represents whether the page color and other background information from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.5] + */ + importPageColor?: boolean; + /** + * Represents whether the paragraph spacing from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.5] + */ + importParagraphSpacing?: boolean; + /** + * Represents whether the styles from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.5] + */ + importStyles?: boolean; + /** + * Represents whether the theme from the source document should be imported. + * + * @remarks + * [Api set: WordApi 1.5] + */ + importTheme?: boolean; + } + /** + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class SearchOptions 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; + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards: boolean; + /** + * 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.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.SearchOptions): 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.SearchOptionsLoadOptions): Word.SearchOptions; + /** + * 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.SearchOptions; + /** + * 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.SearchOptions; + /** + * Create a new instance of the `Word.SearchOptions` object. + */ + 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. + */ + toJSON(): Word.Interfaces.SearchOptionsData; + } + + + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Section 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 body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly body: Word.Body; + /** + * 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.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Section): void; + /** + * Gets one of the section's footers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getFooter(type: Word.HeaderFooterType): Word.Body; + /** + * Gets one of the section's footers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: Word.HeaderFooterType): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.Section; + /** + * Gets the next section. If this section is the last one, 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] + */ + getNextOrNullObject(): Word.Section; + /** + * 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.SectionLoadOptions): Word.Section; + /** + * 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.Section; + /** + * 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.Section; + /** + * 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.Section; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SectionData; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class SectionCollection 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.Section[]; + /** + * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.Section; + /** + * Gets the first section 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 1.3] + */ + getFirstOrNullObject(): Word.Section; + /** + * 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.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; + /** + * 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.SectionCollection; + /** + * 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.SectionCollection; + /** + * 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.SectionCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SectionCollectionData; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class Setting 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 key of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly key: string; + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value: any; + /** + * 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.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Setting): void; + /** + * Deletes the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + delete(): 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.SettingLoadOptions): Word.Setting; + /** + * 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.Setting; + /** + * 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.Setting; + /** + * 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.Setting; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SettingData; + } + /** + * Contains the collection of {@link Word.Setting} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class SettingCollection 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.Setting[]; + /** + * Creates a new setting or sets an existing setting. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param key - Required. The setting's key, which is case-sensitive. + * @param value - Required. The setting's value. + */ + add(key: string, value: any): Word.Setting; + /** + * Deletes all settings in this add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + deleteAll(): void; + /** + * Gets the count of settings. + * + * @remarks + * [Api set: WordApi 1.4] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param key - The key that identifies the setting object. + */ + getItem(key: string): Word.Setting; + /** + * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, 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] + * + * @param key - Required. The key that identifies the setting object. + */ + getItemOrNullObject(key: string): Word.Setting; + /** + * 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.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; + /** + * 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.SettingCollection; + /** + * 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.SettingCollection; + /** + * 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.SettingCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SettingCollectionData; + } + /** + * Contains a collection of {@link Word.Style} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class StyleCollection 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.Style[]; + /** + * Get the style object by its name. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name - Required. The style name. + */ + getByName(name: string): Word.Style; + /** + * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name - Required. The style name. + */ + getByNameOrNullObject(name: string): Word.Style; + /** + * Gets the number of the styles in the collection. + * + * @remarks + * [Api set: WordApi 1.5] + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets a style object by its index in the collection. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param index - A number that identifies the index location of a style object. + */ + getItem(index: number): Word.Style; + /** + * 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.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; + /** + * 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.StyleCollection; + /** + * 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.StyleCollection; + /** + * 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.StyleCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.StyleCollectionData; + } + /** + * Represents a style in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class Style 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 a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly font: Word.Font; + + /** + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly paragraphFormat: Word.ParagraphFormat; + /** + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly shading: Word.Shading; + /** + * Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly tableStyle: Word.TableStyle; + /** + * Specifies the name of an existing style to use as the base formatting of another style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle: string; + /** + * Gets whether the specified style is a built-in style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly builtIn: boolean; + /** + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly inUse: boolean; + /** + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly linked: boolean; + /** + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly nameLocal: string; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle: string; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority: number; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle: boolean; + /** + * Gets the style type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + /** + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed: boolean; + /** + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility: boolean; + /** + * 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.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Style): void; + /** + * Deletes the style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + delete(): 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.StyleLoadOptions): Word.Style; + /** + * 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.Style; + /** + * 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.Style; + /** + * 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.Style; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.StyleData; + } + /** + * Represents the shading object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export class Shading 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; + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor: string; + + + /** + * 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.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shading): 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.ShadingLoadOptions): Word.Shading; + /** + * 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.Shading; + /** + * 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.Shading; + /** + * 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.Shading; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ShadingData; + } + /** + * Represents a table in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class Table 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 collection of endnotes in the table. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of field objects in the table. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the table. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets the parent body of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentBody: Word.Body; + /** + * 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] + */ + readonly parentContentControl: Word.ContentControl; + /** + * 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] + */ + readonly parentContentControlOrNullObject: Word.ContentControl; + /** + * 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] + */ + readonly parentTable: Word.Table; + /** + * 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] + */ + readonly parentTableCell: Word.TableCell; + /** + * 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] + */ + readonly parentTableCellOrNullObject: Word.TableCell; + /** + * 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] + */ + readonly parentTableOrNullObject: Word.Table; + /** + * Gets all of the table rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly rows: Word.TableRowCollection; + /** + * Gets the child tables nested one level deeper. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly tables: Word.TableCollection; + /** + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount: number; + /** + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Indicates whether all of the table rows are uniform. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly isUniform: boolean; + /** + * Gets the nesting level of the table. Top-level tables have level 1. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly nestingLevel: number; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly rowCount: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor: string; + /** + * Specifies the style name for the table. 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style: string; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow: boolean; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values: string[][]; + /** + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Table): void; + /** + * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. + * @param columnCount - Required. Number of columns to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; + /** + * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Start' or 'End'. + * @param rowCount - Required. Number of rows to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + /** + * Autofits the table columns to the width of the window. + * + * @remarks + * [Api set: WordApi 1.3] + */ + autoFitWindow(): void; + /** + * Clears the contents of the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + clear(): void; + /** + * Deletes the entire table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + delete(): void; + /** + * Deletes specific columns. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param columnIndex - Required. The first column to delete. + * @param columnCount - Optional. The number of columns to delete. Default 1. + */ + deleteColumns(columnIndex: number, columnCount?: number): void; + /** + * Deletes specific rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowIndex - Required. The first row to delete. + * @param rowCount - Optional. The number of rows to delete. Default 1. + */ + deleteRows(rowIndex: number, rowCount?: number): void; + /** + * Distributes the column widths evenly. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + distributeColumns(): void; + /** + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + /** + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + /** + * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowIndex - Required. The index of the row. + * @param cellIndex - Required. The index of the cell in the row. + */ + getCell(rowIndex: number, cellIndex: number): Word.TableCell; + /** + * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, 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] + * + * @param rowIndex - Required. The index of the row. + * @param cellIndex - Required. The index of the cell in the row. + */ + getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + /** + * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.Table; + /** + * Gets the next table. If this table is the last one, 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] + */ + getNextOrNullObject(): Word.Table; + /** + * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getParagraphAfter(): Word.Paragraph; + /** + * Gets the paragraph after the table. If there isn't a paragraph after the 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] + */ + getParagraphAfterOrNullObject(): Word.Paragraph; + /** + * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getParagraphBefore(): Word.Paragraph; + /** + * Gets the paragraph before the table. If there isn't a paragraph before the 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] + */ + getParagraphBeforeOrNullObject(): Word.Paragraph; + /** + * Gets the range that contains this table, or the range at the start or end of the table. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + /** + * Inserts a content control on the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + insertContentControl(): Word.ContentControl; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Merges the cells bounded inclusively by a first and last cell. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param topRow - Required. The row of the first cell + * @param firstCell - Required. The index of the first cell in its row + * @param bottomRow - Required. The row of the last cell + * @param lastCell - Required. The index of the last cell in its row + */ + mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): 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.TableLoadOptions): Word.Table; + /** + * 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.Table; + /** + * 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.Table; + /** + * 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.Table; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableData; + } + /** + * Represents the TableStyle object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export class TableStyle 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; + + + /** + * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + bottomCellMargin: number; + /** + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing: number; + /** + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin: number; + /** + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin: number; + /** + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin: 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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableStyle): 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.TableStyleLoadOptions): Word.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableStyleData; + } + /** + * Contains the collection of the document's Table objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableCollection 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.Table[]; + /** + * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.Table; + /** + * Gets the first table 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 1.3] + */ + getFirstOrNullObject(): Word.Table; + /** + * 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.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; + /** + * 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.TableCollection; + /** + * 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.TableCollection; + /** + * 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.TableCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableCollectionData; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableRow 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 cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly cells: Word.TableCellCollection; + /** + * Gets the collection of endnotes in the table row. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly endnotes: Word.NoteItemCollection; + /** + * Gets the collection of field objects in the table row. + * + * @remarks + * [Api set: WordApi 1.4] + */ + readonly fields: Word.FieldCollection; + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly font: Word.Font; + /** + * Gets the collection of footnotes in the table row. + * + * @remarks + * [Api set: WordApi 1.5] + */ + readonly footnotes: Word.NoteItemCollection; + /** + * Gets parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentTable: Word.Table; + /** + * Gets the number of cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly cellCount: number; + /** + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly isHeader: boolean; + /** + * Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight: number; + /** + * Gets the index of the row in its parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly rowIndex: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor: string; + /** + * Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values: string[][]; + /** + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * 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.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; + /** + * Clears the contents of the row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + clear(): void; + /** + * Deletes the entire row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + delete(): void; + /** + * Gets the border style of the cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + /** + * Gets the border style of the cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + /** + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.TableRow; + /** + * Gets the next row. If this row is the last one, 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] + */ + getNextOrNullObject(): Word.TableRow; + + /** + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add + * @param values - Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + */ + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + /** + * Merges the row into one cell. + * + * @remarks + * [Api set: WordApi 1.4] + */ + merge(): Word.TableCell; + /** + * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects the row and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the row and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): 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.TableRowLoadOptions): Word.TableRow; + /** + * 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.TableRow; + /** + * 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.TableRow; + /** + * 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.TableRow; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableRowData; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableRowCollection 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.TableRow[]; + /** + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.TableRow; + /** + * Gets the first row 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 1.3] + */ + getFirstOrNullObject(): Word.TableRow; + /** + * 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.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + /** + * 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.TableRowCollection; + /** + * 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.TableRowCollection; + /** + * 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.TableRowCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableRowCollectionData; + } + /** + * Represents a table cell in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableCell 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 body object of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly body: Word.Body; + /** + * Gets the parent row of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentRow: Word.TableRow; + /** + * Gets the parent table of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly parentTable: Word.Table; + /** + * Gets the index of the cell in its row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly cellIndex: number; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth: number; + /** + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Gets the index of the cell's row in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly rowIndex: number; + /** + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor: string; + /** + * Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value: string; + /** + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Gets the width of the cell in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + readonly 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.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; + /** + * Deletes the column containing this cell. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + deleteColumn(): void; + /** + * Deletes the row containing this cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + deleteRow(): void; + /** + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + /** + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. + */ + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + /** + * Gets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + */ + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + /** + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.TableCell; + /** + * Gets the next cell. If this cell is the last one, 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] + */ + getNextOrNullObject(): Word.TableCell; + /** + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param columnCount - Required. Number of columns to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + /** + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Splits the cell into the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param rowCount - Required. The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount - Required. The number of columns to split into. + */ + split(rowCount: number, columnCount: number): 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.TableCellLoadOptions): Word.TableCell; + /** + * 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.TableCell; + /** + * 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.TableCell; + /** + * 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.TableCell; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableCellData; + } + /** + * Contains the collection of the document's TableCell objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableCellCollection 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.TableCell[]; + /** + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.TableCell; + /** + * Gets the first table cell 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 1.3] + */ + getFirstOrNullObject(): Word.TableCell; + /** + * 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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + /** + * 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.TableCellCollection; + /** + * 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.TableCellCollection; + /** + * 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.TableCellCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableCellCollectionData; + } + /** + * Specifies the border style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableBorder 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; + /** + * Specifies the table border color. + * + * @remarks + * [Api set: WordApi 1.3] + */ + color: string; + /** + * Specifies the type of the table border. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableBorder): 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.TableBorderLoadOptions): Word.TableBorder; + /** + * 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.TableBorder; + /** + * 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.TableBorder; + /** + * 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.TableBorder; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableBorderData; + } + /** + * Represents a tracked change in a Word document. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export class TrackedChange 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 author of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly author: string; + /** + * Gets the date of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly date: Date; + /** + * Gets the text of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly text: string; + /** + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + /** + * Accepts the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + accept(): void; + /** + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getNext(): Word.TrackedChange; + /** + * Gets the next tracked change. If this tracked change is the last one, 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.6] + */ + getNextOrNullObject(): Word.TrackedChange; + /** + * Gets the range of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + /** + * Rejects the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + reject(): 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.TrackedChangeLoadOptions): Word.TrackedChange; + /** + * 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.TrackedChange; + /** + * 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.TrackedChange; + /** + * 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.TrackedChange; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TrackedChangeData; + } + /** + * Contains a collection of {@link Word.TrackedChange} objects. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export class TrackedChangeCollection 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.TrackedChange[]; + /** + * Accepts all the tracked changes in the collection. + * + * @remarks + * [Api set: WordApi 1.6] + */ + acceptAll(): void; + /** + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getFirst(): Word.TrackedChange; + /** + * Gets the first TrackedChange 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 1.6] + */ + getFirstOrNullObject(): Word.TrackedChange; + /** + * Rejects all the tracked changes in the collection. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rejectAll(): 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.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; + /** + * 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.TrackedChangeCollection; + /** + * 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.TrackedChangeCollection; + /** + * 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.TrackedChangeCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TrackedChangeCollectionData; + } + + + + + + + + /** + * Represents the possible change tracking modes. + * + * @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. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventType { + /** + * ContentControlDeleted represents the event that the content control has been deleted. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlDeleted = "ContentControlDeleted", + /** + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlSelectionChanged = "ContentControlSelectionChanged", + /** + * ContentControlDataChanged represents the event that the data in the content control have been changed. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlDataChanged = "ContentControlDataChanged", + /** + * ContentControlAdded represents the event a content control has been added to the document. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlAdded = "ContentControlAdded", + /** + * Represents that a content control has been entered. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlEntered = "ContentControlEntered", + /** + * Represents that a content control has been exited. + * @remarks + * [Api set: WordApi 1.5] + */ + contentControlExited = "ContentControlExited", + /** + * Represents that one or more new paragraphs were added. + * @remarks + * [Api set: WordApi 1.6] + */ + paragraphAdded = "ParagraphAdded", + /** + * Represents that one or more paragraphs were changed. + * @remarks + * [Api set: WordApi 1.6] + */ + paragraphChanged = "ParagraphChanged", + /** + * Represents that one or more paragraphs were deleted. + * @remarks + * [Api set: WordApi 1.6] + */ + paragraphDeleted = "ParagraphDeleted", + } + /** + * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventSource { + /** + * @remarks + * [Api set: WordApi 1.5] + */ + local = "Local", + /** + * @remarks + * [Api set: WordApi 1.5] + */ + remote = "Remote", + } + /** + * Provides information about the content control that raised contentControlAdded event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlAddedEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDataChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDataChangedEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDeleted event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDeletedEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlEntered event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlEnteredEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlExited event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlExitedEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlSelectionChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlSelectionChangedEventArgs { + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.5] + */ + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the content control IDs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + ids: number[]; + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the paragraphs that raised the paragraphAdded event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphAddedEventArgs { + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.6] + */ + source: Word.EventSource | "Local" | "Remote"; + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphChangedEventArgs { + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.6] + */ + source: Word.EventSource | "Local" | "Remote"; + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphDeleted event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphDeletedEventArgs { + /** + * The source of the event. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.6] + */ + source: Word.EventSource | "Local" | "Remote"; + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalIds: string[]; + } + /** + * Specifies supported content control types and subtypes. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum ContentControlType { + /** + * @remarks + * [Api set: WordApi 1.1] + */ + unknown = "Unknown", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + richTextInline = "RichTextInline", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + richTextParagraphs = "RichTextParagraphs", + /** + * Contains a whole cell. + * @remarks + * [Api set: WordApi 1.1] + */ + richTextTableCell = "RichTextTableCell", + /** + * Contains a whole row. + * @remarks + * [Api set: WordApi 1.1] + */ + richTextTableRow = "RichTextTableRow", + /** + * Contains a whole table. + * @remarks + * [Api set: WordApi 1.1] + */ + richTextTable = "RichTextTable", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + plainTextInline = "PlainTextInline", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + plainTextParagraph = "PlainTextParagraph", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + picture = "Picture", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + buildingBlockGallery = "BuildingBlockGallery", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + checkBox = "CheckBox", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + comboBox = "ComboBox", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dropDownList = "DropDownList", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + datePicker = "DatePicker", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + repeatingSection = "RepeatingSection", + /** + * Identifies a rich text content control. + * @remarks + * [Api set: WordApi 1.1] + */ + richText = "RichText", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + plainText = "PlainText", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + group = "Group", + } + /** + * ContentControl appearance. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Content control appearance options are BoundingBox, Tags, or Hidden. + */ + enum ContentControlAppearance { + /** + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * @remarks + * [Api set: WordApi 1.1] + */ + boundingBox = "BoundingBox", + /** + * Represents a content control shown as start and end markers. + * @remarks + * [Api set: WordApi 1.1] + */ + tags = "Tags", + /** + * Represents a content control that isn't shown. + * @remarks + * [Api set: WordApi 1.1] + */ + hidden = "Hidden", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { + /** + * @remarks + * [Api set: WordApi 1.1] + */ + mixed = "Mixed", + /** + * No underline. + * @remarks + * [Api set: WordApi 1.1] + */ + none = "None", + /** + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. + * @remarks + * [Api set: WordApi 1.1] + */ + hidden = "Hidden", + /** + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. + * @remarks + * [Api set: WordApi 1.1] + */ + dotLine = "DotLine", + /** + * A single underline. This is the default value. + * @remarks + * [Api set: WordApi 1.1] + */ + single = "Single", + /** + * Only underline individual words. + * @remarks + * [Api set: WordApi 1.1] + */ + word = "Word", + /** + * A double underline. + * @remarks + * [Api set: WordApi 1.1] + */ + double = "Double", + /** + * A single thick underline. + * @remarks + * [Api set: WordApi 1.1] + */ + thick = "Thick", + /** + * A dotted underline. + * @remarks + * [Api set: WordApi 1.1] + */ + dotted = "Dotted", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dottedHeavy = "DottedHeavy", + /** + * A single dash underline. + * @remarks + * [Api set: WordApi 1.1] + */ + dashLine = "DashLine", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dashLineHeavy = "DashLineHeavy", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dashLineLong = "DashLineLong", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dashLineLongHeavy = "DashLineLongHeavy", + /** + * An alternating dot-dash underline. + * @remarks + * [Api set: WordApi 1.1] + */ + dotDashLine = "DotDashLine", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dotDashLineHeavy = "DotDashLineHeavy", + /** + * An alternating dot-dot-dash underline. + * @remarks + * [Api set: WordApi 1.1] + */ + twoDotDashLine = "TwoDotDashLine", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + twoDotDashLineHeavy = "TwoDotDashLineHeavy", + /** + * A single wavy underline. + * @remarks + * [Api set: WordApi 1.1] + */ + wave = "Wave", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + waveHeavy = "WaveHeavy", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { + /** + * Page break at the insertion point. + * @remarks + * [Api set: WordApi 1.1] + */ + page = "Page", + /** + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. + * @remarks + * [Api set: WordApi 1.1] + */ + next = "Next", + /** + * Section break on next page. + * @remarks + * [Api set: WordApi 1.1] + */ + sectionNext = "SectionNext", + /** + * New section without a corresponding page break. + * @remarks + * [Api set: WordApi 1.1] + */ + sectionContinuous = "SectionContinuous", + /** + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * @remarks + * [Api set: WordApi 1.1] + */ + sectionEven = "SectionEven", + /** + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * @remarks + * [Api set: WordApi 1.1] + */ + sectionOdd = "SectionOdd", + /** + * Line break. + * @remarks + * [Api set: WordApi 1.1] + */ + line = "Line", + } + /** + * The insertion location types. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is "Before" or "After", the new content will be outside of the modified object. + * If the location is "Start" or "End", the new content will be included as part of the modified object. + */ + enum InsertLocation { + /** + * Add content before the contents of the calling object. + * @remarks + * [Api set: WordApi 1.1] + */ + before = "Before", + /** + * Add content after the contents of the calling object. + * @remarks + * [Api set: WordApi 1.1] + */ + after = "After", + /** + * Prepend content to the contents of the calling object. + * @remarks + * [Api set: WordApi 1.1] + */ + start = "Start", + /** + * Append content to the contents of the calling object. + * @remarks + * [Api set: WordApi 1.1] + */ + end = "End", + /** + * Replace the contents of the current object. + * @remarks + * [Api set: WordApi 1.1] + */ + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { + /** + * @remarks + * [Api set: WordApi 1.1] + */ + mixed = "Mixed", + /** + * Unknown alignment. + * @remarks + * [Api set: WordApi 1.1] + */ + unknown = "Unknown", + /** + * Alignment to the left. + * @remarks + * [Api set: WordApi 1.1] + */ + left = "Left", + /** + * Alignment to the center. + * @remarks + * [Api set: WordApi 1.1] + */ + centered = "Centered", + /** + * Alignment to the right. + * @remarks + * [Api set: WordApi 1.1] + */ + right = "Right", + /** + * Fully justified alignment. + * @remarks + * [Api set: WordApi 1.1] + */ + justified = "Justified", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { + /** + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * @remarks + * [Api set: WordApi 1.1] + */ + primary = "Primary", + /** + * Returns the header or footer on the first page of a section. + * @remarks + * [Api set: WordApi 1.1] + */ + firstPage = "FirstPage", + /** + * Returns all headers or footers on even-numbered pages of a section. + * @remarks + * [Api set: WordApi 1.1] + */ + 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", + } + /** + * This enum sets where the cursor (insertion point) in the document is after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { + /** + * The entire range is selected. + * @remarks + * [Api set: WordApi 1.1] + */ + select = "Select", + /** + * The cursor is at the beginning of the selection (just before the start of the selected range). + * @remarks + * [Api set: WordApi 1.1] + */ + start = "Start", + /** + * The cursor is at the end of the selection (just after the end of the selected range). + * @remarks + * [Api set: WordApi 1.1] + */ + end = "End", + } + + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { + /** + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. + * @remarks + * [Api set: WordApi 1.3] + */ + whole = "Whole", + /** + * The starting point of the object. For content control, it's the point after the opening tag. + * @remarks + * [Api set: WordApi 1.3] + */ + start = "Start", + /** + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. + * @remarks + * [Api set: WordApi 1.3] + */ + end = "End", + /** + * For content control only. It's the point before the opening tag. + * @remarks + * [Api set: WordApi 1.3] + */ + before = "Before", + /** + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. + * @remarks + * [Api set: WordApi 1.3] + */ + after = "After", + /** + * The range between 'Start' and 'End'. + * @remarks + * [Api set: WordApi 1.3] + */ + content = "Content", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { + /** + * Indicates that this instance and the range are in different sub-documents. + * @remarks + * [Api set: WordApi 1.3] + */ + unrelated = "Unrelated", + /** + * Indicates that this instance and the range represent the same range. + * @remarks + * [Api set: WordApi 1.3] + */ + equal = "Equal", + /** + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + containsStart = "ContainsStart", + /** + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + containsEnd = "ContainsEnd", + /** + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + contains = "Contains", + /** + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + insideStart = "InsideStart", + /** + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + insideEnd = "InsideEnd", + /** + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * @remarks + * [Api set: WordApi 1.3] + */ + inside = "Inside", + /** + * Indicates that this instance occurs before, and is adjacent to, the range. + * @remarks + * [Api set: WordApi 1.3] + */ + adjacentBefore = "AdjacentBefore", + /** + * Indicates that this instance starts before the range and overlaps the range's first character. + * @remarks + * [Api set: WordApi 1.3] + */ + overlapsBefore = "OverlapsBefore", + /** + * Indicates that this instance occurs before the range. + * @remarks + * [Api set: WordApi 1.3] + */ + before = "Before", + /** + * Indicates that this instance occurs after, and is adjacent to, the range. + * @remarks + * [Api set: WordApi 1.3] + */ + adjacentAfter = "AdjacentAfter", + /** + * Indicates that this instance starts inside the range and overlaps the range’s last character. + * @remarks + * [Api set: WordApi 1.3] + */ + overlapsAfter = "OverlapsAfter", + /** + * Indicates that this instance occurs after the range. + * @remarks + * [Api set: WordApi 1.3] + */ + after = "After", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderLocation { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + top = "Top", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + left = "Left", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + right = "Right", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + insideHorizontal = "InsideHorizontal", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + insideVertical = "InsideVertical", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + inside = "Inside", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + outside = "Outside", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + all = "All", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + top = "Top", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + left = "Left", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bottom = "Bottom", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + right = "Right", + } + + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + mixed = "Mixed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + none = "None", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + single = "Single", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + double = "Double", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dotted = "Dotted", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dashed = "Dashed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dotDashed = "DotDashed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dot2Dashed = "Dot2Dashed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + triple = "Triple", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickSmall = "ThinThickSmall", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thickThinSmall = "ThickThinSmall", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickThinSmall = "ThinThickThinSmall", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickMed = "ThinThickMed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thickThinMed = "ThickThinMed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickThinMed = "ThinThickThinMed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickLarge = "ThinThickLarge", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thickThinLarge = "ThickThinLarge", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + thinThickThinLarge = "ThinThickThinLarge", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + wave = "Wave", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + doubleWave = "DoubleWave", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dashedSmall = "DashedSmall", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + dashDotStroked = "DashDotStroked", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + threeDEmboss = "ThreeDEmboss", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + threeDEngrave = "ThreeDEngrave", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum VerticalAlignment { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + mixed = "Mixed", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + top = "Top", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + center = "Center", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bottom = "Bottom", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListLevelType { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bullet = "Bullet", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + number = "Number", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + custom = "Custom", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + solid = "Solid", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + hollow = "Hollow", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + square = "Square", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + diamonds = "Diamonds", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + arrow = "Arrow", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + checkmark = "Checkmark", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListNumbering { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + none = "None", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + arabic = "Arabic", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + upperRoman = "UpperRoman", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + lowerRoman = "LowerRoman", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + upperLetter = "UpperLetter", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + lowerLetter = "LowerLetter", + } + /** + * Represents the built-in style in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + */ + enum BuiltInStyleName { + /** + * Mixed styles or other style not in this list. + * @remarks + * [Api set: WordApi 1.3] + */ + other = "Other", + /** + * Reset character and paragraph style to default. + * @remarks + * [Api set: WordApi 1.3] + */ + normal = "Normal", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading1 = "Heading1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading2 = "Heading2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading3 = "Heading3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading4 = "Heading4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading5 = "Heading5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading6 = "Heading6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading7 = "Heading7", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading8 = "Heading8", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + heading9 = "Heading9", + /** + * Table-of-content level 1. + * @remarks + * [Api set: WordApi 1.3] + */ + toc1 = "Toc1", + /** + * Table-of-content level 2. + * @remarks + * [Api set: WordApi 1.3] + */ + toc2 = "Toc2", + /** + * Table-of-content level 3. + * @remarks + * [Api set: WordApi 1.3] + */ + toc3 = "Toc3", + /** + * Table-of-content level 4. + * @remarks + * [Api set: WordApi 1.3] + */ + toc4 = "Toc4", + /** + * Table-of-content level 5. + * @remarks + * [Api set: WordApi 1.3] + */ + toc5 = "Toc5", + /** + * Table-of-content level 6. + * @remarks + * [Api set: WordApi 1.3] + */ + toc6 = "Toc6", + /** + * Table-of-content level 7. + * @remarks + * [Api set: WordApi 1.3] + */ + toc7 = "Toc7", + /** + * Table-of-content level 8. + * @remarks + * [Api set: WordApi 1.3] + */ + toc8 = "Toc8", + /** + * Table-of-content level 9. + * @remarks + * [Api set: WordApi 1.3] + */ + toc9 = "Toc9", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + footnoteText = "FootnoteText", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + header = "Header", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + footer = "Footer", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + caption = "Caption", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + footnoteReference = "FootnoteReference", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + endnoteReference = "EndnoteReference", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + endnoteText = "EndnoteText", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + title = "Title", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + subtitle = "Subtitle", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink = "Hyperlink", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + strong = "Strong", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + emphasis = "Emphasis", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + noSpacing = "NoSpacing", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listParagraph = "ListParagraph", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + quote = "Quote", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + intenseQuote = "IntenseQuote", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + subtleEmphasis = "SubtleEmphasis", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + intenseEmphasis = "IntenseEmphasis", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + subtleReference = "SubtleReference", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + intenseReference = "IntenseReference", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bookTitle = "BookTitle", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + bibliography = "Bibliography", + /** + * Table-of-content heading. + * @remarks + * [Api set: WordApi 1.3] + */ + tocHeading = "TocHeading", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + tableGrid = "TableGrid", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + plainTable1 = "PlainTable1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + plainTable2 = "PlainTable2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + plainTable3 = "PlainTable3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + plainTable4 = "PlainTable4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + plainTable5 = "PlainTable5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + tableGridLight = "TableGridLight", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light = "GridTable1Light", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent1 = "GridTable1Light_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent2 = "GridTable1Light_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent3 = "GridTable1Light_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent4 = "GridTable1Light_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent5 = "GridTable1Light_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable1Light_Accent6 = "GridTable1Light_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2 = "GridTable2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent1 = "GridTable2_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent2 = "GridTable2_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent3 = "GridTable2_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent4 = "GridTable2_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent5 = "GridTable2_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable2_Accent6 = "GridTable2_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3 = "GridTable3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent1 = "GridTable3_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent2 = "GridTable3_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent3 = "GridTable3_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent4 = "GridTable3_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent5 = "GridTable3_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable3_Accent6 = "GridTable3_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4 = "GridTable4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent1 = "GridTable4_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent2 = "GridTable4_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent3 = "GridTable4_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent4 = "GridTable4_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent5 = "GridTable4_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable4_Accent6 = "GridTable4_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark = "GridTable5Dark", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful = "GridTable6Colorful", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful = "GridTable7Colorful", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light = "ListTable1Light", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent1 = "ListTable1Light_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent2 = "ListTable1Light_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent3 = "ListTable1Light_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent4 = "ListTable1Light_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent5 = "ListTable1Light_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable1Light_Accent6 = "ListTable1Light_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2 = "ListTable2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent1 = "ListTable2_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent2 = "ListTable2_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent3 = "ListTable2_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent4 = "ListTable2_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent5 = "ListTable2_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable2_Accent6 = "ListTable2_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3 = "ListTable3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent1 = "ListTable3_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent2 = "ListTable3_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent3 = "ListTable3_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent4 = "ListTable3_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent5 = "ListTable3_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable3_Accent6 = "ListTable3_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4 = "ListTable4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent1 = "ListTable4_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent2 = "ListTable4_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent3 = "ListTable4_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent4 = "ListTable4_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent5 = "ListTable4_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable4_Accent6 = "ListTable4_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark = "ListTable5Dark", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful = "ListTable6Colorful", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful = "ListTable7Colorful", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { + /** + * @remarks + * [Api set: WordApi 1.3] + */ + string = "String", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + number = "Number", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + date = "Date", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + boolean = "Boolean", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { + /** + * Represents that the style is a character style. + * @remarks + * [Api set: WordApi 1.5] + */ + character = "Character", + /** + * Represents that the style is a list style. Currently supported on desktop. + * @remarks + * [Api set: WordApi 1.5] + */ + list = "List", + /** + * Represents that the style is a paragraph style. + * @remarks + * [Api set: WordApi 1.5] + */ + paragraph = "Paragraph", + /** + * Represents that the style is a table style. + * @remarks + * [Api set: WordApi 1.5] + */ + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { + /** + * Represents outline level 1. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel1 = "OutlineLevel1", + /** + * Represents outline level 2. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel2 = "OutlineLevel2", + /** + * Represents outline level 3. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel3 = "OutlineLevel3", + /** + * Represents outline level 4. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel4 = "OutlineLevel4", + /** + * Represents outline level 5. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel5 = "OutlineLevel5", + /** + * Represents outline level 6. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel6 = "OutlineLevel6", + /** + * Represents outline level 7. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel7 = "OutlineLevel7", + /** + * Represents outline level 8. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel8 = "OutlineLevel8", + /** + * Represents outline level 9. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel9 = "OutlineLevel9", + /** + * Represents outline level body text, not an outline level. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevelBodyText = "OutlineLevelBodyText", + } + /** + * Specifies the close behavior for `Document.close`. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum CloseBehavior { + /** + * Saves the changes before closing the document. + * @remarks + * [Api set: WordApi 1.5] + */ + save = "Save", + /** + * Discard the possible changes when closing the document. + * @remarks + * [Api set: WordApi 1.5] + */ + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { + /** + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. + * @remarks + * [Api set: WordApi 1.1] + */ + save = "Save", + /** + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. + * @remarks + * [Api set: WordApi 1.1] + */ + prompt = "Prompt", + } + /** + * Represents the type of Field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { + /** + * Represents that the field type is Add-in. + * @remarks + * [Api set: WordApi 1.5] + */ + addin = "Addin", + /** + * Represents that the field type is AddressBlock. + * @remarks + * [Api set: WordApi 1.5] + */ + addressBlock = "AddressBlock", + /** + * Represents that the field type is Advance. + * @remarks + * [Api set: WordApi 1.5] + */ + advance = "Advance", + /** + * Represents that the field type is Ask. + * @remarks + * [Api set: WordApi 1.5] + */ + ask = "Ask", + /** + * Represents that the field type is Author. + * @remarks + * [Api set: WordApi 1.5] + */ + author = "Author", + /** + * Represents that the field type is AutoText. + * @remarks + * [Api set: WordApi 1.5] + */ + autoText = "AutoText", + /** + * Represents that the field type is AutoTextList. + * @remarks + * [Api set: WordApi 1.5] + */ + autoTextList = "AutoTextList", + /** + * Represents that the field type is Barcode. + * @remarks + * [Api set: WordApi 1.5] + */ + barCode = "BarCode", + /** + * Represents that the field type is Bibliography. + * @remarks + * [Api set: WordApi 1.5] + */ + bibliography = "Bibliography", + /** + * Represents that the field type is BidiOutline. + * @remarks + * [Api set: WordApi 1.5] + */ + bidiOutline = "BidiOutline", + /** + * Represents that the field type is Citation. + * @remarks + * [Api set: WordApi 1.5] + */ + citation = "Citation", + /** + * Represents that the field type is Comments. + * @remarks + * [Api set: WordApi 1.5] + */ + comments = "Comments", + /** + * Represents that the field type is Compare. + * @remarks + * [Api set: WordApi 1.5] + */ + compare = "Compare", + /** + * Represents that the field type is CreateDate. + * @remarks + * [Api set: WordApi 1.5] + */ + createDate = "CreateDate", + /** + * Represents that the field type is Data. + * @remarks + * [Api set: WordApi 1.5] + */ + data = "Data", + /** + * Represents that the field type is Database. + * @remarks + * [Api set: WordApi 1.5] + */ + database = "Database", + /** + * Represents that the field type is Date. + * @remarks + * [Api set: WordApi 1.5] + */ + date = "Date", + /** + * Represents that the field type is DisplayBarcode. + * @remarks + * [Api set: WordApi 1.5] + */ + displayBarcode = "DisplayBarcode", + /** + * Represents that the field type is DocumentProperty + * @remarks + * [Api set: WordApi 1.5] + */ + docProperty = "DocProperty", + /** + * Represents that the field type is DocumentVariable. + * @remarks + * [Api set: WordApi 1.5] + */ + docVariable = "DocVariable", + /** + * Represents that the field type is EditTime. + * @remarks + * [Api set: WordApi 1.5] + */ + editTime = "EditTime", + /** + * Represents that the field type is Embedded. + * @remarks + * [Api set: WordApi 1.5] + */ + embedded = "Embedded", + /** + * Represents that the field type is Equation. + * @remarks + * [Api set: WordApi 1.5] + */ + eq = "EQ", + /** + * Represents that the field type is Expression. + * @remarks + * [Api set: WordApi 1.5] + */ + expression = "Expression", + /** + * Represents that the field type is FileName. + * @remarks + * [Api set: WordApi 1.5] + */ + fileName = "FileName", + /** + * Represents that the field type is FileSize. + * @remarks + * [Api set: WordApi 1.5] + */ + fileSize = "FileSize", + /** + * Represents that the field type is FillIn. + * @remarks + * [Api set: WordApi 1.5] + */ + fillIn = "FillIn", + /** + * Represents that the field type is FormCheckbox. + * @remarks + * [Api set: WordApi 1.5] + */ + formCheckbox = "FormCheckbox", + /** + * Represents that the field type is FormDropdown. + * @remarks + * [Api set: WordApi 1.5] + */ + formDropdown = "FormDropdown", + /** + * Represents that the field type is FormText. + * @remarks + * [Api set: WordApi 1.5] + */ + formText = "FormText", + /** + * Represents that the field type is GotoButton. + * @remarks + * [Api set: WordApi 1.5] + */ + gotoButton = "GotoButton", + /** + * Represents that the field type is GreetingLine. + * @remarks + * [Api set: WordApi 1.5] + */ + greetingLine = "GreetingLine", + /** + * Represents that the field type is Hyperlink. + * @remarks + * [Api set: WordApi 1.5] + */ + hyperlink = "Hyperlink", + /** + * Represents that the field type is If. + * @remarks + * [Api set: WordApi 1.5] + */ + if = "If", + /** + * Represents that the field type is Import. + * @remarks + * [Api set: WordApi 1.5] + */ + import = "Import", + /** + * Represents that the field type is Include. + * @remarks + * [Api set: WordApi 1.5] + */ + include = "Include", + /** + * Represents that the field type is IncludePicture. + * @remarks + * [Api set: WordApi 1.5] + */ + includePicture = "IncludePicture", + /** + * Represents that the field type is IncludeText. + * @remarks + * [Api set: WordApi 1.5] + */ + includeText = "IncludeText", + /** + * Represents that the field type is Index. + * @remarks + * [Api set: WordApi 1.5] + */ + index = "Index", + /** + * Represents that the field type is Information. + * @remarks + * [Api set: WordApi 1.5] + */ + info = "Info", + /** + * Represents that the field type is Keywords. + * @remarks + * [Api set: WordApi 1.5] + */ + keywords = "Keywords", + /** + * Represents that the field type is LastSavedBy. + * @remarks + * [Api set: WordApi 1.5] + */ + lastSavedBy = "LastSavedBy", + /** + * Represents that the field type is Link. + * @remarks + * [Api set: WordApi 1.5] + */ + link = "Link", + /** + * Represents that the field type is ListNumber. + * @remarks + * [Api set: WordApi 1.5] + */ + listNum = "ListNum", + /** + * Represents that the field type is MacroButton. + * @remarks + * [Api set: WordApi 1.5] + */ + macroButton = "MacroButton", + /** + * Represents that the field type is MergeBarcode. + * @remarks + * [Api set: WordApi 1.5] + */ + mergeBarcode = "MergeBarcode", + /** + * Represents that the field type is MergeField. + * @remarks + * [Api set: WordApi 1.5] + */ + mergeField = "MergeField", + /** + * Represents that the field type is MergeRecord. + * @remarks + * [Api set: WordApi 1.5] + */ + mergeRec = "MergeRec", + /** + * Represents that the field type is MergeSequence. + * @remarks + * [Api set: WordApi 1.5] + */ + mergeSeq = "MergeSeq", + /** + * Represents that the field type is Next. + * @remarks + * [Api set: WordApi 1.5] + */ + next = "Next", + /** + * Represents that the field type is NextIf. + * @remarks + * [Api set: WordApi 1.5] + */ + nextIf = "NextIf", + /** + * Represents that the field type is NoteReference. + * @remarks + * [Api set: WordApi 1.5] + */ + noteRef = "NoteRef", + /** + * Represents that the field type is NumberOfCharacters. + * @remarks + * [Api set: WordApi 1.5] + */ + numChars = "NumChars", + /** + * Represents that the field type is NumberOfPages. + * @remarks + * [Api set: WordApi 1.5] + */ + numPages = "NumPages", + /** + * Represents that the field type is NumberOfWords. + * @remarks + * [Api set: WordApi 1.5] + */ + numWords = "NumWords", + /** + * Represents that the field type is ActiveXControl. + * @remarks + * [Api set: WordApi 1.5] + */ + ocx = "OCX", + /** + * Represents that the field type is Page. + * @remarks + * [Api set: WordApi 1.5] + */ + page = "Page", + /** + * Represents that the field type is PageReference. + * @remarks + * [Api set: WordApi 1.5] + */ + pageRef = "PageRef", + /** + * Represents that the field type is Print. + * @remarks + * [Api set: WordApi 1.5] + */ + print = "Print", + /** + * Represents that the field type is PrintDate. + * @remarks + * [Api set: WordApi 1.5] + */ + printDate = "PrintDate", + /** + * Represents that the field type is Private. + * @remarks + * [Api set: WordApi 1.5] + */ + private = "Private", + /** + * Represents that the field type is Quote. + * @remarks + * [Api set: WordApi 1.5] + */ + quote = "Quote", + /** + * Represents that the field type is ReferencedDocument. + * @remarks + * [Api set: WordApi 1.5] + */ + rd = "RD", + /** + * Represents that the field type is Reference. + * @remarks + * [Api set: WordApi 1.5] + */ + ref = "Ref", + /** + * Represents that the field type is RevisionNumber. + * @remarks + * [Api set: WordApi 1.5] + */ + revNum = "RevNum", + /** + * Represents that the field type is SaveDate. + * @remarks + * [Api set: WordApi 1.5] + */ + saveDate = "SaveDate", + /** + * Represents that the field type is Section. + * @remarks + * [Api set: WordApi 1.5] + */ + section = "Section", + /** + * Represents that the field type is SectionPages. + * @remarks + * [Api set: WordApi 1.5] + */ + sectionPages = "SectionPages", + /** + * Represents that the field type is Sequence. + * @remarks + * [Api set: WordApi 1.5] + */ + seq = "Seq", + /** + * Represents that the field type is Set. + * @remarks + * [Api set: WordApi 1.5] + */ + set = "Set", + /** + * Represents that the field type is Shape. + * @remarks + * [Api set: WordApi 1.5] + */ + shape = "Shape", + /** + * Represents that the field type is SkipIf. + * @remarks + * [Api set: WordApi 1.5] + */ + skipIf = "SkipIf", + /** + * Represents that the field type is StyleReference. + * @remarks + * [Api set: WordApi 1.5] + */ + styleRef = "StyleRef", + /** + * Represents that the field type is Subject. + * @remarks + * [Api set: WordApi 1.5] + */ + subject = "Subject", + /** + * Represents that the field type is Subscriber. + * @remarks + * [Api set: WordApi 1.5] + */ + subscriber = "Subscriber", + /** + * Represents that the field type is Symbol. + * @remarks + * [Api set: WordApi 1.5] + */ + symbol = "Symbol", + /** + * Represents that the field type is TableOfAuthoritiesEntry. + * @remarks + * [Api set: WordApi 1.5] + */ + ta = "TA", + /** + * Represents that the field type is TableOfContentsEntry. + * @remarks + * [Api set: WordApi 1.5] + */ + tc = "TC", + /** + * Represents that the field type is Template. + * @remarks + * [Api set: WordApi 1.5] + */ + template = "Template", + /** + * Represents that the field type is Time. + * @remarks + * [Api set: WordApi 1.5] + */ + time = "Time", + /** + * Represents that the field type is Title. + * @remarks + * [Api set: WordApi 1.5] + */ + title = "Title", + /** + * Represents that the field type is TableOfAuthorities. + * @remarks + * [Api set: WordApi 1.5] + */ + toa = "TOA", + /** + * Represents that the field type is TableOfContents. + * @remarks + * [Api set: WordApi 1.5] + */ + toc = "TOC", + /** + * Represents that the field type is UserAddress. + * @remarks + * [Api set: WordApi 1.5] + */ + userAddress = "UserAddress", + /** + * Represents that the field type is UserInitials. + * @remarks + * [Api set: WordApi 1.5] + */ + userInitials = "UserInitials", + /** + * Represents that the field type is UserName. + * @remarks + * [Api set: WordApi 1.5] + */ + userName = "UserName", + /** + * Represents that the field type is IndexEntry. + * @remarks + * [Api set: WordApi 1.5] + */ + xe = "XE", + /** + * Represents that the field type is Empty. + * @remarks + * [Api set: WordApi 1.5] + */ + empty = "Empty", + /** + * Represents the field types not supported by the Office JavaScript API. + * @remarks + * [Api set: WordApi 1.5] + */ + others = "Others", + /** + * Represents that the field type is Undefined. + * @remarks + * [Api set: WordApi 1.5] + */ + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { + /** + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. + * @remarks + * [Api set: WordApi 1.5] + */ + none = "None", + /** + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. + * @remarks + * [Api set: WordApi 1.5] + */ + hot = "Hot", + /** + * Represents that the field is automatically updated when the source changes or the field can be manually updated. + * @remarks + * [Api set: WordApi 1.5] + */ + warm = "Warm", + /** + * Represents that the field doesn't have a result. + * @remarks + * [Api set: WordApi 1.5] + */ + cold = "Cold", + } + + + + + + + + + + + + + + + + + + + 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. + */ + $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. + */ + $skip?: number; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + export interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + export interface BorderUpdateData { + + + + + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + export interface BorderCollectionUpdateData { + + + + + + + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + export interface CheckboxContentControlUpdateData { + + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + export interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + export interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + export interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + export interface ContentControlUpdateData { + + /** + * 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'. + * + * @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] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + export interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + export interface ContentControlListItemUpdateData { + + + + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + export interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + export interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + export interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + export interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + export interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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({ ... })`. */ + export interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** 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] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + export interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + export interface FontUpdateData { + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + export interface InlinePictureUpdateData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + export interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + export interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + export interface ListItemUpdateData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + export interface ListLevelUpdateData { + + + + + + + + + + + + } + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + export interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + export interface ListTemplateUpdateData { + + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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({ ... })`. */ + export interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + export interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + export interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + export interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; + } + /** 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] + */ + 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] + */ + 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] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: number; + /** + * Specifies the style name for the paragraph. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + export interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + export interface ParagraphFormatUpdateData { + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent?: number; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether?: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: string; + /** + * Specifies the style name for the range. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + export interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + export interface SearchOptionsUpdateData { + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + } + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + export interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + export interface SettingUpdateData { + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: any; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + export interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + export interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + export interface StyleUpdateData { + + /** + * 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 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] + */ + shading?: Word.Interfaces.ShadingUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: string; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: number; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + export interface ShadingUpdateData { + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor?: string; + + + } + /** 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] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount?: number; + /** + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the style name for the table. 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: string; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + export interface TableStyleUpdateData { + + + /** + * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + bottomCellMargin?: number; + /** + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: number; + /** + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: number; + /** + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: number; + /** + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: number; + } + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + export interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** 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] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight?: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + export interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: number; + /** + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: string; + /** + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + export interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + export interface TableBorderUpdateData { + /** + * Specifies the table border color. + * + * @remarks + * [Api set: WordApi 1.3] + */ + color?: string; + /** + * Specifies the type of the table border. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + export interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { + + + + + + + + + + + + + + + + + + + + + + + + + + + + } + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + export interface ShapeGroupUpdateData { + + } + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + export interface CanvasUpdateData { + + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + export interface ShapeFillUpdateData { + + + + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + export interface TextFrameUpdateData { + + + + + + + + + + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + export interface ShapeTextWrapUpdateData { + + + + + + + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + export interface CritiqueAnnotationData { + + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + export interface AnnotationData { + + + } + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + export interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** 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] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * 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] + */ + 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] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * 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. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem"; + } + /** An interface describing the data returned by calling `border.toJSON()`. */ + export interface BorderData { + + + + + + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + export interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + export interface CheckboxContentControlData { + + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + export interface CommentData { + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the collection of reply objects associated with the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + replies?: Word.Interfaces.CommentReplyData[]; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: string; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: Date; + /** + * Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + export interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + export interface CommentContentRangeData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] + */ + isEmpty?: boolean; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + text?: string; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + export interface CommentReplyData { + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: string; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: string; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: Date; + /** + * Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + export interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + export interface ContentControlData { + + + /** + * 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 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] + */ + 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] + */ + 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] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] + */ + id?: number; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + /** + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] + */ + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + } + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + export interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + export interface ContentControlListItemData { + + + + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + export interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + export interface CustomPropertyData { + /** + * Gets the key of the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + key?: string; + /** + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + export interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + export interface CustomXmlPartData { + /** + * Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: string; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + export interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + export interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + export interface DocumentData { + + /** + * 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.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + saved?: boolean; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + export interface DocumentCreatedData { + /** + * 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.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * 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. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + export interface DocumentPropertiesData { + /** + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + applicationName?: string; + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + creationDate?: Date; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Gets the last author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastAuthor?: string; + /** + * Gets the last print date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastPrintDate?: Date; + /** + * Gets the last save time of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastSaveTime?: Date; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Gets the revision number of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + revisionNumber?: string; + /** + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * + * @remarks + * [Api set: WordApi 1.3] + */ + security?: number; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Gets the template of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + template?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + export interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + export interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + export interface FieldData { + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] + */ + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + + /** + * Gets the field's type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + } + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + export interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + export interface FontData { + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + export interface InlinePictureData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + export interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface describing the data returned by calling `list.toJSON()`. */ + export interface ListData { + /** + * Gets paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the list's id. + * + * @remarks + * [Api set: WordApi 1.3] + */ + id?: number; + /** + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelExistences?: boolean[]; + /** + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelTypes?: Word.ListLevelType[]; + } + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + export interface ListCollectionData { + items?: Word.Interfaces.ListData[]; + } + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + export interface ListItemData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + /** + * Gets the list item bullet, number, or picture as a string. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listString?: string; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + export interface ListLevelData { + + + + + + + + + + + + } + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + export interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + export interface ListTemplateData { + + + } + /** 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] + */ + body?: Word.Interfaces.BodyData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.NoteItemType | "Footnote" | "Endnote"; + } + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + export interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + export interface PageData { + + + + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + export interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + export interface PaneData { + + + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + export interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + export interface WindowData { + } + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + export interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; + } + /** 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + listItemOrNullObject?: Word.Interfaces.ListItemData; + + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isLastParagraph?: boolean; + /** + * Checks whether the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isListItem?: boolean; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: number; + /** + * Specifies the style name for the paragraph. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tableNestingLevel?: number; + /** + * Gets the text of the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + export interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + export interface ParagraphFormatData { + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent?: number; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether?: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** 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] + */ + 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] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the collection of inline picture objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + + + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: string; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isEmpty?: boolean; + /** + * Specifies the style name for the range. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + export interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + export interface SearchOptionsData { + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; + } + /** 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] + */ + body?: Word.Interfaces.BodyData; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + export interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + export interface SettingData { + /** + * Gets the key of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + key?: string; + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: any; + } + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + export interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + export interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + export interface StyleData { + + /** + * 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 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] + */ + shading?: Word.Interfaces.ShadingData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: string; + /** + * Gets whether the specified style is a built-in style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + builtIn?: boolean; + /** + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + inUse?: boolean; + /** + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] + */ + linked?: boolean; + /** + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] + */ + nameLocal?: string; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: number; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * Gets the style type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + /** + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + export interface ShadingData { + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor?: string; + + + } + /** 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] + */ + 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] + */ + font?: Word.Interfaces.FontData; + /** + * 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] + */ + tables?: Word.Interfaces.TableData[]; + /** + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount?: number; + /** + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Indicates whether all of the table rows are uniform. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isUniform?: boolean; + /** + * Gets the nesting level of the table. Top-level tables have level 1. + * + * @remarks + * [Api set: WordApi 1.3] + */ + nestingLevel?: number; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowCount?: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the style name for the table. 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: string; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + export interface TableStyleData { + + + /** + * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + bottomCellMargin?: number; + /** + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: number; + /** + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: number; + /** + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: number; + /** + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + export interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + export interface TableRowData { + /** + * Gets cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cells?: Word.Interfaces.TableCellData[]; + /** + * Gets the collection of field objects in the table row. + * + * @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] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the number of cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellCount?: number; + /** + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isHeader?: boolean; + /** + * Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight?: number; + /** + * Gets the index of the row in its parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: number; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: string[][]; + /** + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + export interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** 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] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets the index of the cell in its row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellIndex?: number; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: number; + /** + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Gets the index of the cell's row in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: number; + /** + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: string; + /** + * Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: string; + /** + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + /** + * Gets the width of the cell in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + export interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + export interface TableBorderData { + /** + * Specifies the table border color. + * + * @remarks + * [Api set: WordApi 1.3] + */ + color?: string; + /** + * Specifies the type of the table border. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + export interface TrackedChangeData { + /** + * Gets the author of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + author?: string; + /** + * Gets the date of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + date?: Date; + /** + * Gets the text of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + text?: string; + /** + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + export interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + export interface ShapeGroupData { + + + + } + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + export interface CanvasData { + + + + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + export interface ShapeFillData { + + + + + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + export interface TextFrameData { + + + + + + + + + + + } + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + export interface ShapeTextWrapData { + + + + + + + } + + + + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface BodyLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; + } + + + + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentLoadOptions { + /** + 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; + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + /** + * Gets the email of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: boolean; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: boolean; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: boolean; + /** + * Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentCollectionLoadOptions { + /** + 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: 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentContentRangeLoadOptions { + /** + 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; + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: boolean; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.4] + */ + isEmpty?: boolean; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + text?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: boolean; + } + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentReplyLoadOptions { + /** + 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; + /** + * 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] + */ + parentComment?: Word.Interfaces.CommentLoadOptions; + /** + * Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: boolean; + /** + * Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: boolean; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: boolean; + /** + * Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + } + /** + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentReplyCollectionLoadOptions { + /** + 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: 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] + */ + parentComment?: Word.Interfaces.CommentLoadOptions; + /** + * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorEmail?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + 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, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface ContentControlLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: boolean; + /** + * 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] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: boolean; + /** + * Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] + */ + id?: boolean; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: boolean; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subtype?: boolean; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: boolean; + /** + * Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: boolean; + /** + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] + */ + 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, plain text, checkbox, dropdown list, and combo box content controls are supported. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface ContentControlCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: boolean; + /** + * For EACH ITEM in the collection: 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; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: boolean; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * For EACH ITEM in the collection: Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subtype?: boolean; + /** + * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: boolean; + /** + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] + */ + type?: boolean; + } + + + /** + * Represents a custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface CustomPropertyLoadOptions { + /** + 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 key of the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + key?: boolean; + /** + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface CustomPropertyCollectionLoadOptions { + /** + 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: Gets the key of the custom property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; + } + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartLoadOptions { + /** + 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 ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartCollectionLoadOptions { + /** + 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: Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartScopedCollectionLoadOptions { + /** + 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: Gets the ID of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + namespaceUri?: boolean; + } + /** + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface DocumentLoadOptions { + /** + 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 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] + */ + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + saved?: boolean; + } + /** + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface DocumentCreatedLoadOptions { + /** + 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 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] + */ + 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. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + saved?: boolean; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface DocumentPropertiesLoadOptions { + /** + 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 application name of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + applicationName?: boolean; + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: boolean; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: boolean; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: boolean; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: boolean; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + creationDate?: boolean; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: boolean; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: boolean; + /** + * Gets the last author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastAuthor?: boolean; + /** + * Gets the last print date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastPrintDate?: boolean; + /** + * Gets the last save time of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lastSaveTime?: boolean; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: boolean; + /** + * Gets the revision number of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + revisionNumber?: boolean; + /** + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * + * @remarks + * [Api set: WordApi 1.3] + */ + security?: boolean; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: boolean; + /** + * Gets the template of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + template?: boolean; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: boolean; + } + /** + * Represents a field. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export interface FieldLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: boolean; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: boolean; + /** + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] + */ + kind?: boolean; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + + /** + * Gets the field's type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + } + /** + * Contains a collection of {@link Word.Field} objects. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export interface FieldCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: boolean; + /** + * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: boolean; + /** + * For EACH ITEM in the collection: Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] + */ + kind?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + + /** + * For EACH ITEM in the collection: Gets the field's type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + } + /** + * Represents a font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface FontLoadOptions { + /** + 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; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: boolean; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: boolean; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: boolean; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: boolean; + } + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface InlinePictureLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: boolean; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: boolean; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: boolean; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: boolean; + + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: boolean; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface InlinePictureCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: boolean; + /** + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: boolean; + /** + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: boolean; + /** + * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: boolean; + + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListLoadOptions { + /** + 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 list's id. + * + * @remarks + * [Api set: WordApi 1.3] + */ + id?: boolean; + /** + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelExistences?: boolean; + /** + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListCollectionLoadOptions { + /** + 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: Gets the list's id. + * + * @remarks + * [Api set: WordApi 1.3] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelExistences?: boolean; + /** + * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListItemLoadOptions { + /** + 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; + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: boolean; + /** + * Gets the list item bullet, number, or picture as a string. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listString?: boolean; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + siblingIndex?: boolean; + } + + + + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface NoteItemLoadOptions { + /** + 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 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] + */ + reference?: Word.Interfaces.RangeLoadOptions; + /** + * Represents the note item type: footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface NoteItemCollectionLoadOptions { + /** + 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 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] + */ + reference?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + } + + + /** + * Represents a single paragraph in a selection, range, content control, or document body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface ParagraphLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + listOrNullObject?: Word.Interfaces.ListLoadOptions; + /** + * 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: boolean; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: boolean; + /** + * Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isLastParagraph?: boolean; + /** + * Checks whether the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isListItem?: boolean; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: boolean; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: boolean; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: boolean; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: boolean; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: boolean; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: boolean; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: boolean; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: boolean; + /** + * Specifies the style name for the paragraph. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tableNestingLevel?: boolean; + /** + * Gets the text of the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalId?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface ParagraphCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + listOrNullObject?: Word.Interfaces.ListLoadOptions; + /** + * 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: boolean; + /** + * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isLastParagraph?: boolean; + /** + * For EACH ITEM in the collection: Checks whether the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isListItem?: boolean; + /** + * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: boolean; + /** + * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: boolean; + /** + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: boolean; + /** + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: boolean; + /** + * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: boolean; + /** + * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: boolean; + /** + * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: boolean; + /** + * For EACH ITEM in the collection: Specifies the style name for the paragraph. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tableNestingLevel?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalId?: boolean; + } + /** + * Represents a style of paragraph in a document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ParagraphFormatLoadOptions { + /** + 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; + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment?: boolean; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent?: boolean; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether?: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: boolean; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: boolean; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: boolean; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: boolean; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: boolean; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: boolean; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: boolean; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: boolean; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** + * Represents a contiguous area in a document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface RangeLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: boolean; + /** + * Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isEmpty?: boolean; + /** + * Specifies the style name for the range. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + } + /** + * Contains a collection of {@link Word.Range} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface RangeCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: boolean; + /** + * For EACH ITEM in the collection: Checks whether the range length is zero. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isEmpty?: boolean; + /** + * For EACH ITEM in the collection: Specifies the style name for the range. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + } + /** + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface SearchOptionsLoadOptions { + /** + 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; + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface SectionLoadOptions { + /** + 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 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; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface SectionCollectionLoadOptions { + /** + 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: 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; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface SettingLoadOptions { + /** + 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 key of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + key?: boolean; + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: boolean; + } + /** + * Contains the collection of {@link Word.Setting} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface SettingCollectionLoadOptions { + /** + 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: Gets the key of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + key?: boolean; + /** + * For EACH ITEM in the collection: Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: boolean; + } + /** + * Contains a collection of {@link Word.Style} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface StyleCollectionLoadOptions { + /** + 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: 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 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] + */ + 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: boolean; + /** + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + builtIn?: boolean; + /** + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + inUse?: boolean; + /** + * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] + */ + linked?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] + */ + nameLocal?: boolean; + /** + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: boolean; + /** + * For EACH ITEM in the collection: Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * For EACH ITEM in the collection: Gets the style type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** + * Represents a style in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface StyleLoadOptions { + /** + 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 a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontLoadOptions; + + /** + * 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] + */ + shading?: Word.Interfaces.ShadingLoadOptions; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: boolean; + /** + * Gets whether the specified style is a built-in style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + builtIn?: boolean; + /** + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + inUse?: boolean; + /** + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] + */ + linked?: boolean; + /** + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] + */ + nameLocal?: boolean; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: boolean; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: boolean; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * Gets the style type. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: boolean; + /** + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** + * Represents the shading object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ShadingLoadOptions { + /** + 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; + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor?: boolean; + + + } + /** + * Represents a table in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableLoadOptions { + /** + 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 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + /** + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: boolean; + /** + * Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount?: boolean; + /** + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * Indicates whether all of the table rows are uniform. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isUniform?: boolean; + /** + * Gets the nesting level of the table. Top-level tables have level 1. + * + * @remarks + * [Api set: WordApi 1.3] + */ + nestingLevel?: boolean; + /** + * Gets the number of rows in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowCount?: boolean; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * Specifies the style name for the table. 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: boolean; + /** + * Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: boolean; + /** + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + /** + * Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; + } + /** + * Represents the TableStyle object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface TableStyleLoadOptions { + /** + 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; + + + /** + * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + bottomCellMargin?: boolean; + /** + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: boolean; + /** + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: boolean; + /** + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: boolean; + /** + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: boolean; + } + /** + * Contains the collection of the document's Table objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableCollectionLoadOptions { + /** + 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: 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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] + */ + 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'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies the number of header rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + headerRowCount?: boolean; + /** + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isUniform?: boolean; + /** + * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. + * + * @remarks + * [Api set: WordApi 1.3] + */ + nestingLevel?: boolean; + /** + * For EACH ITEM in the collection: Gets the number of rows in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowCount?: boolean; + /** + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the style name for the table. 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + style?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the table has banded columns. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedColumns?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the table has banded rows. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBandedRows?: boolean; + /** + * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleFirstColumn?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleLastColumn?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width of the table in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableRowLoadOptions { + /** + 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 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] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Gets the number of cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellCount?: boolean; + /** + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isHeader?: boolean; + /** + * Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight?: boolean; + /** + * Gets the index of the row in its parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: boolean; + /** + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: boolean; + /** + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableRowCollectionLoadOptions { + /** + 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: 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] + */ + parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Gets the number of cells in the row. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellCount?: boolean; + /** + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isHeader?: boolean; + /** + * For EACH ITEM in the collection: Specifies the preferred height of the row in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + preferredHeight?: boolean; + /** + * For EACH ITEM in the collection: Gets the index of the row in its parent table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: boolean; + /** + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the text values in the row, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] + */ + values?: boolean; + /** + * For EACH ITEM in the collection: Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + } + /** + * Represents a table cell in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableCellLoadOptions { + /** + 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 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] + */ + parentRow?: Word.Interfaces.TableRowLoadOptions; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellIndex?: boolean; + /** + * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: boolean; + /** + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * Gets the index of the cell's row in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: boolean; + /** + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; + /** + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + /** + * Gets the width of the cell in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; + } + /** + * Contains the collection of the document's TableCell objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableCellCollectionLoadOptions { + /** + 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: 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] + */ + parentRow?: Word.Interfaces.TableRowLoadOptions; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cellIndex?: boolean; + /** + * For EACH ITEM in the collection: Specifies the width of the cell's column in points. This is applicable to uniform tables. + * + * @remarks + * [Api set: WordApi 1.3] + */ + columnWidth?: boolean; + /** + * For EACH ITEM in the collection: Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + horizontalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Gets the index of the cell's row in the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + rowIndex?: boolean; + /** + * For EACH ITEM in the collection: Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.3] + */ + shadingColor?: boolean; + /** + * For EACH ITEM in the collection: Specifies the text of the cell. + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; + /** + * For EACH ITEM in the collection: Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + verticalAlignment?: boolean; + /** + * For EACH ITEM in the collection: Gets the width of the cell in points. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; + } + /** + * Specifies the border style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableBorderLoadOptions { + /** + 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; + /** + * Specifies the table border color. + * + * @remarks + * [Api set: WordApi 1.3] + */ + color?: boolean; + /** + * Specifies the type of the table border. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; + /** + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: boolean; + } + /** + * Represents a tracked change in a Word document. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface TrackedChangeLoadOptions { + /** + 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 author of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + author?: boolean; + /** + * Gets the date of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + date?: boolean; + /** + * Gets the text of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + text?: boolean; + /** + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type?: boolean; + } + /** + * Contains a collection of {@link Word.TrackedChange} objects. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface TrackedChangeCollectionLoadOptions { + /** + 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: Gets the author of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + author?: boolean; + /** + * For EACH ITEM in the collection: Gets the date of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + date?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type?: boolean; + } + + + + + + + + } +} +export declare namespace Word { + /** + * The RequestContext object facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the request context is required to get access to the Word object model from the add-in. + */ + export class RequestContext extends OfficeExtension.ClientRequestContext { + constructor(url?: string); + readonly document: Document; + /** [Api set: WordApi 1.3] **/ + readonly application: Application; + } + /** + * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects. + * @param objects - An array of previously created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by `context.sync()`. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of `context.sync()`). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. + */ + export function run(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Word object model, using the RequestContext of a previously created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param object - A previously created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by `context.sync()`. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of `context.sync()`). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. + */ + export function run(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise): Promise; + /** + * Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. + * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of `context.sync()`). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in. + */ + export function run(batch: (context: Word.RequestContext) => Promise): Promise; +} + + +//////////////////////////////////////////////////////////////// +//////////////////////// End Word APIs ///////////////////////// +//////////////////////////////////////////////////////////////// \ No newline at end of file diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts index 1eb9c8e0da..59db2d8fb5 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts @@ -3489,55 +3489,13 @@ export declare namespace Word { export class DocumentCreated 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 body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - readonly body: Word.Body; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - readonly contentControls: Word.ContentControlCollection; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - readonly customXmlParts: Word.CustomXmlPartCollection; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - readonly properties: Word.DocumentProperties; - /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - readonly sections: Word.SectionCollection; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - readonly settings: Word.SettingCollection; - /** - * 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. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - readonly saved: boolean; + + + + + + + /** * 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. @@ -3546,87 +3504,14 @@ export declare namespace Word { set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.DocumentCreated): void; - /** - * Adds a style into the document by name and type. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. - */ - addStyle(name: string, type: Word.StyleType): Word.Style; - /** - * Adds a style into the document by name and type. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. - */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; - /** - * Deletes a bookmark, if it exists, from the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. - */ - deleteBookmark(name: string): void; - /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. - */ - getBookmarkRange(name: string): Word.Range; - /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. - */ - getBookmarkRangeOrNullObject(name: string): Word.Range; - /** - * Gets the currently supported content controls in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options - Optional. Options that define which content controls are returned. - */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; - /** - * Gets a StyleCollection object that represents the whole style set of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - */ - getStyles(): Word.StyleCollection; - /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * 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'. - * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + + + + + + + + /** * Opens the document. * @@ -3634,30 +3519,8 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ open(): void; - /** - * Saves the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. - */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; - /** - * Saves the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. - */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + + /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -13753,20 +13616,8 @@ 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] - */ - body?: Word.Interfaces.BodyUpdateData; - /** - * 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({ ... })`. */ export interface DocumentPropertiesUpdateData { @@ -15613,55 +15464,13 @@ export declare namespace Word { } /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ export interface DocumentCreatedData { - /** - * 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.BodyData; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; - /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; - /** - * 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. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - saved?: boolean; + + + + + + + } /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ export interface DocumentPropertiesData { @@ -18477,27 +18286,9 @@ export declare namespace Word { 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 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] - */ - 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. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - saved?: boolean; + + + } /** * Represents document properties. diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts index ed7b9d5169..69b95d38d2 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts @@ -1643,7 +1643,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; - + /** + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly comboBoxContentControl: Word.ComboBoxContentControl; /** * Gets the collection of content control objects in the content control. * @@ -1651,7 +1657,13 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; - + /** + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly dropDownListContentControl: Word.DropDownListContentControl; /** * Gets the collection of endnotes in the content control. * @@ -2291,8 +2303,152 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.ContentControlCollectionData; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItem 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value: string; + /** + * 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.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ContentControlListItem): void; + /** + * Deletes the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + delete(): void; + /** + * Selects the list item and sets the text of the content control to the value of the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + select(): 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.ContentControlListItemLoadOptions): Word.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemData; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItemCollection 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.ContentControlListItem[]; + /** + * Gets the first list item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.9] + */ + getFirst(): Word.ContentControlListItem; + /** + * Gets the first list item 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 1.9] + */ + getFirstOrNullObject(): Word.ContentControlListItem; + /** + * 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.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemCollectionData; + } /** * Specifies the options that define which content controls are returned. * @@ -3417,26 +3573,8 @@ export declare namespace Word { set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.DocumentCreated): void; - /** - * Adds a style into the document by name and type. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. - */ - addStyle(name: string, type: Word.StyleType): Word.Style; - /** - * Adds a style into the document by name and type. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. - */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + + /** * Deletes a bookmark, if it exists, from the document. * @@ -3464,40 +3602,9 @@ export declare namespace Word { * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ getBookmarkRangeOrNullObject(name: string): Word.Range; - /** - * Gets the currently supported content controls in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options - Optional. Options that define which content controls are returned. - */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; - /** - * Gets a StyleCollection object that represents the whole style set of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - */ - getStyles(): Word.StyleCollection; - /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * 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'. - * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + + + /** * Opens the document. * @@ -3742,8 +3849,132 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.DocumentPropertiesData; } - - + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class DropDownListContentControl 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 collection of list items in the dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DropDownListContentControlData; + } + /** + * The data specific to content controls of type 'ComboBox'. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ComboBoxContentControl 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 collection of list items in the combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ComboBoxContentControlData; + } /** * Represents a field. * @@ -16400,9 +16631,27 @@ export declare namespace Word { } /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ export interface ContentControlListItemUpdateData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ export interface ContentControlListItemCollectionUpdateData { @@ -18298,7 +18547,13 @@ export declare namespace Word { * [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] + */ + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** * Gets the collection of content control objects in the content control. * @@ -18306,7 +18561,13 @@ export declare namespace Word { * [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] + */ + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** * Gets the collection of field objects in the content control. * @@ -18456,9 +18717,27 @@ export declare namespace Word { } /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ export interface ContentControlListItemData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ export interface ContentControlListItemCollectionData { @@ -21585,8 +21864,72 @@ export declare namespace Word { */ type?: boolean; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemLoadOptions { + /** + 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemCollectionLoadOptions { + /** + 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: Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } /** * Represents a custom property. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts index 9330ca4ea3..a8a1665dbb 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts @@ -1643,7 +1643,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; - + /** + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly comboBoxContentControl: Word.ComboBoxContentControl; /** * Gets the collection of content control objects in the content control. * @@ -1651,7 +1657,13 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; - + /** + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly dropDownListContentControl: Word.DropDownListContentControl; /** * Gets the collection of endnotes in the content control. * @@ -2291,8 +2303,152 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.ContentControlCollectionData; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItem 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value: string; + /** + * 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.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ContentControlListItem): void; + /** + * Deletes the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + delete(): void; + /** + * Selects the list item and sets the text of the content control to the value of the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + select(): 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.ContentControlListItemLoadOptions): Word.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemData; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItemCollection 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.ContentControlListItem[]; + /** + * Gets the first list item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.9] + */ + getFirst(): Word.ContentControlListItem; + /** + * Gets the first list item 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 1.9] + */ + getFirstOrNullObject(): Word.ContentControlListItem; + /** + * 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.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemCollectionData; + } /** * Specifies the options that define which content controls are returned. * @@ -3374,13 +3530,7 @@ export declare namespace Word { * [Api set: WordApiHiddenDocument 1.3] */ readonly contentControls: Word.ContentControlCollection; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - readonly customXmlParts: Word.CustomXmlPartCollection; + /** * Gets the properties of the document. * @@ -3395,13 +3545,7 @@ export declare namespace Word { * [Api set: WordApiHiddenDocument 1.3] */ readonly sections: Word.SectionCollection; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - readonly settings: Word.SettingCollection; + /** * 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. * @@ -3419,33 +3563,9 @@ export declare namespace Word { set(properties: Word.DocumentCreated): void; - /** - * Deletes a bookmark, if it exists, from the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. - */ - deleteBookmark(name: string): void; - /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. - */ - getBookmarkRange(name: string): Word.Range; - /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. - */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + + + @@ -3693,8 +3813,132 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.DocumentPropertiesData; } - - + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class DropDownListContentControl 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 collection of list items in the dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DropDownListContentControlData; + } + /** + * The data specific to content controls of type 'ComboBox'. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ComboBoxContentControl 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 collection of list items in the combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ComboBoxContentControlData; + } /** * Represents a field. * @@ -16351,9 +16595,27 @@ export declare namespace Word { } /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ export interface ContentControlListItemUpdateData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ export interface ContentControlListItemCollectionUpdateData { @@ -18249,7 +18511,13 @@ export declare namespace Word { * [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] + */ + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** * Gets the collection of content control objects in the content control. * @@ -18257,7 +18525,13 @@ export declare namespace Word { * [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] + */ + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** * Gets the collection of field objects in the content control. * @@ -18407,9 +18681,27 @@ export declare namespace Word { } /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ export interface ContentControlListItemData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ export interface ContentControlListItemCollectionData { @@ -18557,13 +18849,7 @@ export declare namespace Word { * [Api set: WordApiHiddenDocument 1.3] */ contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** * Gets the properties of the document. * @@ -18578,13 +18864,7 @@ export declare namespace Word { * [Api set: WordApiHiddenDocument 1.3] */ sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + /** * 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. * @@ -21536,8 +21816,72 @@ export declare namespace Word { */ type?: boolean; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemLoadOptions { + /** + 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemCollectionLoadOptions { + /** + 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: Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } /** * Represents a custom property. * diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts index f1b0368e28..14ff2b9885 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts @@ -1643,7 +1643,13 @@ export declare namespace Word { * [Api set: WordApi 1.7] */ readonly checkboxContentControl: Word.CheckboxContentControl; - + /** + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly comboBoxContentControl: Word.ComboBoxContentControl; /** * Gets the collection of content control objects in the content control. * @@ -1651,7 +1657,13 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; - + /** + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly dropDownListContentControl: Word.DropDownListContentControl; /** * Gets the collection of endnotes in the content control. * @@ -2291,8 +2303,152 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.ContentControlCollectionData; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItem 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value: string; + /** + * 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.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ContentControlListItem): void; + /** + * Deletes the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + delete(): void; + /** + * Selects the list item and sets the text of the content control to the value of the list item. + * + * @remarks + * [Api set: WordApi 1.9] + */ + select(): 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.ContentControlListItemLoadOptions): Word.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.ContentControlListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemData; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ContentControlListItemCollection 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.ContentControlListItem[]; + /** + * Gets the first list item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.9] + */ + getFirst(): Word.ContentControlListItem; + /** + * Gets the first list item 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 1.9] + */ + getFirstOrNullObject(): Word.ContentControlListItem; + /** + * 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.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.ContentControlListItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ContentControlListItemCollectionData; + } /** * Specifies the options that define which content controls are returned. * @@ -3605,8 +3761,132 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.DocumentPropertiesData; } - - + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class DropDownListContentControl 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 collection of list items in the dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this dropdown list content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.DropDownListContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.DropDownListContentControlData; + } + /** + * The data specific to content controls of type 'ComboBox'. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class ComboBoxContentControl 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 collection of list items in the combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + readonly listItems: Word.ContentControlListItemCollection; + /** + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * + * @remarks + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + */ + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + /** + * Deletes all list items in this combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + deleteAllListItems(): void; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.ComboBoxContentControl; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ComboBoxContentControlData; + } /** * Represents a field. * @@ -16263,9 +16543,27 @@ export declare namespace Word { } /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ export interface ContentControlListItemUpdateData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ export interface ContentControlListItemCollectionUpdateData { @@ -18149,7 +18447,13 @@ export declare namespace Word { * [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] + */ + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** * Gets the collection of content control objects in the content control. * @@ -18157,7 +18461,13 @@ export declare namespace Word { * [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] + */ + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** * Gets the collection of field objects in the content control. * @@ -18307,9 +18617,27 @@ export declare namespace Word { } /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ export interface ContentControlListItemData { - - - + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; } /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ export interface ContentControlListItemCollectionData { @@ -21394,8 +21722,72 @@ export declare namespace Word { */ type?: boolean; } - - + /** + * Represents a list item in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemLoadOptions { + /** + 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; + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemCollectionLoadOptions { + /** + 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: Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: boolean; + /** + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; + } /** * Represents a custom property. * diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index d80a713d30..d91f3076ab 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -4232,7 +4232,7 @@ export declare namespace Word { /** 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -4248,7 +4248,7 @@ export declare namespace Word { */ readonly errorCode: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -6552,6 +6552,14 @@ export declare namespace Word { * @beta */ attachedTemplate: Word.Template; + /** + * Gets a `Shape` object that represents the background image for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly background: Word.Shape; /** * Returns a `Bibliography` object that represents the bibliography references contained within the document. * @@ -6575,6 +6583,22 @@ export declare namespace Word { * @beta */ readonly bookmarks: Word.BookmarkCollection; + /** + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly builtInDocumentProperties: Word.DocumentProperties; + /** + * Gets the `RangeScopedCollection` object that represents all the characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly characters: Word.RangeScopedCollection; /** * Gets a `Coauthoring` object for managing coauthoring in the document. * @@ -6583,6 +6607,22 @@ export declare namespace Word { * @beta */ readonly coauthoring: Word.Coauthoring; + /** + * Gets a `CommentCollection` object that represents all the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly comments: Word.CommentCollection; + /** + * Gets a `Range` object that represents the main document story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly content: Word.Range; /** * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * @@ -6590,6 +6630,14 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; + /** + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly customDocumentProperties: Word.DocumentProperties; /** * Gets the custom XML parts in the document. * @@ -6605,6 +6653,14 @@ export declare namespace Word { * @beta */ readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection; + /** + * Gets a `FieldCollection` object that represents all the fields in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fields: Word.FieldCollection; /** * Returns a `FrameCollection` object that represents all the frames in the document. * @@ -6613,6 +6669,14 @@ export declare namespace Word { * @beta */ readonly frames: Word.FrameCollection; + /** + * Gets a `RangeCollection` object that represents the sentences that failed the grammar check in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly grammaticalErrors: Word.RangeCollection; /** * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * @@ -6629,6 +6693,14 @@ export declare namespace Word { * @beta */ readonly indexes: Word.IndexCollection; + /** + * Gets a `ParagraphCollection` object that represents all the numbered paragraphs in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listParagraphs: Word.ParagraphCollection; /** * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * @@ -6637,6 +6709,14 @@ export declare namespace Word { * @beta */ readonly listTemplates: Word.ListTemplateCollection; + /** + * Gets a `ListCollection` object that contains all the formatted lists in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly lists: Word.ListCollection; /** * Returns a `PageSetup` object that's associated with the document. * @@ -6645,6 +6725,14 @@ export declare namespace Word { * @beta */ readonly pageSetup: Word.PageSetup; + /** + * Gets a `ParagraphCollection` object that represents all the paragraphs in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly paragraphs: Word.ParagraphCollection; /** * Gets the properties of the document. * @@ -6652,6 +6740,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly properties: Word.DocumentProperties; + /** + * Gets a `ReadabilityStatisticCollection` object that represents the readability statistics for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly readabilityStatistics: Word.ReadabilityStatisticCollection; /** * Gets the collection of revisions that represents the tracked changes in the document. * @@ -6675,6 +6771,14 @@ export declare namespace Word { * @beta */ readonly selection: Word.Selection; + /** + * Gets the `RangeScopedCollection` object that represents all the sentences in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sentences: Word.RangeScopedCollection; /** * Gets the add-in's settings in the document. * @@ -6682,6 +6786,30 @@ export declare namespace Word { * [Api set: WordApi 1.4] */ readonly settings: Word.SettingCollection; + /** + * Gets a `RangeCollection` object that represents the words identified as spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly spellingErrors: Word.RangeCollection; + /** + * Gets a `RangeCollection` object that represents all the stories in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyRanges: Word.RangeCollection; + /** + * Gets a `StyleCollection` for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly styles: Word.StyleCollection; /** * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. * @@ -6690,6 +6818,14 @@ export declare namespace Word { * @beta */ readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; + /** + * Gets a `TableCollection` object that represents all the tables in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tables: Word.TableCollection; /** * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. * @@ -6714,6 +6850,14 @@ export declare namespace Word { * @beta */ readonly tablesOfFigures: Word.TableOfFiguresCollection; + /** + * Gets the `WebSettings` object for webpage-related attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly webSettings: Word.WebSettings; /** * Gets the collection of `Word.Window` objects for the document. * @@ -6722,1827 +6866,1905 @@ export declare namespace Word { */ readonly windows: Word.WindowCollection; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets the `RangeScopedCollection` object that represents each word in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation: boolean; + readonly words: Word.RangeScopedCollection; /** - * Specifies if the edits in the document are automatically saved. + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn: boolean; + readonly activeTheme: string; /** - * Specifies the ChangeTracking mode. + * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + readonly activeThemeDisplayName: string; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit: number; + readonly areFilePropertiesPasswordEncrypted: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps: boolean; + areGrammaticalErrorsShown: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies whether to use the default math settings when creating new equations. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected: boolean; + areMathDefaultsUsed: boolean; /** - * 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. + * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly saved: boolean; + areNewerFeaturesDisabled: boolean; /** - * 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. + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Document): void; + areSpellingErrorsShown: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: Word.StyleType): Word.Style; + areStylesUpdatedOnOpen: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + areTrueTypeFontsEmbedded: boolean; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - close(closeBehavior?: Word.CloseBehavior): void; + autoHyphenation: boolean; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - close(closeBehavior?: "Save" | "SkipSave"): void; + autoSaveOn: boolean; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param filePath - Required. The path of the document with which the specified document is compared. - * @param documentCompareOptions - Optional. The additional options that specifies the behavior of comparing document. + * [Api set: WordApi 1.4] */ - compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Gets the code name for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64File - Required. The Base64-encoded content of the document with which the specified document is compared. - * @param documentCompareOptions - Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + readonly codeName: string; /** - * Deletes a bookmark, if it exists, from the document. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name - Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteBookmark(name: string): void; + readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** - * Analyzes the document text to determine the language. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): void; + consecutiveHyphensLimit: number; /** - * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi 1.7] - * - * @param id - The ID of the annotation to get. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAnnotationById(id: string): Word.Annotation; + readonly currentRsid: number; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name - Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRange(name: string): Word.Range; + defaultTabStop: number; /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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}. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name - Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + defaultTargetFrame: string; /** - * Gets the currently supported content controls in the document. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options - Optional. Options that define which content controls are returned. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + doNotEmbedSystemFonts: boolean; /** - * Gets the document's endnotes in a single body. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getEndnoteBody(): Word.Body; + encryptionProvider: string; /** - * Gets the document's footnotes in a single body. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFootnoteBody(): Word.Body; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. + * Specifies the line break control level. * * @remarks - * [Api set: WordApi 1.6] - * - * @param id - Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getParagraphByUniqueLocalId(id: string): Word.Paragraph; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the current selection of the document. Multiple selections aren't supported. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getSelection(): Word.Range; + formattingIsNextLevelShown: boolean; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getStyles(): Word.StyleCollection; + formattingIsUserStyleNameShown: boolean; /** - * Import styles from a JSON-formatted string. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + readonly fullName: string; /** - * Import styles from a JSON-formatted string. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson - Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; + gridDistanceHorizontal: number; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.5] - * - * 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'. - * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + gridDistanceVertical: number; /** - * Initiates manual hyphenation of a document, one line at a time. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manualHyphenation(): void; + gridIsOriginFromMargin: boolean; /** - * Saves the document. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + gridOriginHorizontal: number; /** - * Saves the document. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + gridOriginVertical: number; /** - * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + gridSpaceBetweenHorizontalLines: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the interval for vertical character gridlines in print layout view. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; + gridSpaceBetweenVerticalLines: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether a password is required to open the document. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Document; + readonly hasPassword: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Document; + readonly hasVbProject: boolean; /** - * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationClicked: OfficeExtension.EventHandlers; + hyphenateCaps: boolean; /** - * Occurs when the user hovers the cursor over an annotation. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationHovered: OfficeExtension.EventHandlers; + hyphenationZone: number; /** - * Occurs when the user adds one or more annotations. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationInserted: OfficeExtension.EventHandlers; + isAutoFormatOverrideOn: boolean; /** - * Occurs when the user performs an action in an annotation pop-up menu. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi 1.8] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; + isChartDataPointTracked: boolean; /** - * Occurs when the user deletes one or more annotations. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationRemoved: OfficeExtension.EventHandlers; + isCompatible: boolean; /** - * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. + * Specifies whether the document is final. * * @remarks - * [Api set: WordApi 1.5] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onContentControlAdded: OfficeExtension.EventHandlers; + isFinal: boolean; /** - * Occurs when the user adds new paragraphs. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphAdded: OfficeExtension.EventHandlers; + isFontsSubsetSaved: boolean; /** - * Occurs when the user changes paragraphs. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphChanged: OfficeExtension.EventHandlers; + isFormsDataPrinted: boolean; /** - * Occurs when the user deletes paragraphs. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphDeleted: OfficeExtension.EventHandlers; + isFormsDataSaved: boolean; /** - * 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. + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Document; + isGrammarChecked: boolean; /** - * 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. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Document; + readonly isInAutoSave: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Gets whether the document is in form design mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentData; - } - /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class DocumentCreated 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; + readonly isInFormsDesign: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + isKerningByAlgorithm: boolean; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly contentControls: Word.ContentControlCollection; + isLinguisticDataEmbedded: boolean; /** - * Gets the custom XML parts in the document. + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly customXmlParts: Word.CustomXmlPartCollection; + readonly isMasterDocument: boolean; /** - * Gets the properties of the document. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly properties: Word.DocumentProperties; + isOptimizedForWord97: boolean; /** - * Gets the collection of section objects in the document. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly sections: Word.SectionCollection; + isPostScriptPrintedOverText: boolean; /** - * Gets the add-in's settings in the document. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly settings: Word.SettingCollection; + isQuickStyleSetLocked: boolean; /** - * 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. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly saved: boolean; + readonly isReadOnly: boolean; /** - * 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. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentCreated): void; + isReadOnlyRecommended: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: Word.StyleType): Word.Style; + isSnappedToGrid: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name - Required. A string representing the style name. - * @param type - Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + isSnappedToShapes: boolean; /** - * Deletes a bookmark, if it exists, from the document. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteBookmark(name: string): void; + isSpellingChecked: boolean; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRange(name: string): Word.Range; + isStyleEnforced: boolean; /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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}. + * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + readonly isSubdocument: boolean; /** - * Gets the currently supported content controls in the document. + * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options - Optional. Options that define which content controls are returned. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + isThemeLocked: boolean; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getStyles(): Word.StyleCollection; + isUserControl: boolean; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * 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'. - * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + readonly isVbaSigned: boolean; /** - * Opens the document. + * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - open(): void; + readonly isWriteReserved: boolean; /** - * Saves the document. + * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Saves the document. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. - * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word has detected the language of the document text. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; + languageDetected: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the kinsoku characters after which Word will not break a line. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentCreated; + noLineBreakAfter: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the kinsoku characters before which Word will not break a line. * - * @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.DocumentCreated; - /** - * 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.DocumentCreated; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentCreatedData; - } - /** - * Represents document properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class DocumentProperties 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; + noLineBreakBefore: string; /** - * Gets the collection of custom properties of the document. + * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly customProperties: Word.CustomPropertyCollection; + readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the application name of the document. + * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly applicationName: string; + readonly originalDocumentTitle: string; /** - * Specifies the author of the document. + * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author: string; + password: string; /** - * Specifies the category of the document. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category: string; + readonly passwordEncryptionAlgorithm: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments: string; + readonly passwordEncryptionKeyLength: number; /** - * Specifies the company of the document. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company: string; + readonly passwordEncryptionProvider: string; /** - * Gets the creation date of the document. + * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly creationDate: Date; + readonly path: string; /** - * Specifies the format of the document. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format: string; + printRevisions: boolean; /** - * Specifies the keywords of the document. + * Gets the protection type for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords: string; + readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** - * Gets the last author of the document. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastAuthor: string; + readingLayoutSizeX: number; /** - * Gets the last print date of the document. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastPrintDate: Date; + readingLayoutSizeY: number; /** - * Gets the last save time of the document. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastSaveTime: Date; + readingModeIsLayoutFrozen: boolean; /** - * Specifies the manager of the document. + * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager: string; + removePersonalInformationOnSave: boolean; /** - * Gets the revision number of the document. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly revisionNumber: string; + readonly revisedDocumentTitle: string; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly security: number; + saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the subject of the document. + * Gets the file format of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject: string; + readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Gets the template of the document. + * 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly template: string; + readonly saved: boolean; /** - * Specifies the title of the document. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi 1.3] - */ - title: string; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentProperties): void; + textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies how Word marks line and paragraph breaks in text files. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; + textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to track formatting changes when change tracking is on. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentProperties; + trackFormatting: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to mark moved text when Track Changes is on. * - * @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.DocumentProperties; - /** - * 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.DocumentProperties; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.DocumentProperties; + trackMoves: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentPropertiesData; - } - /** - * The data specific to content controls of type DropDownList. - * - * @remarks - * [Api set: WordApi 1.9] - */ - export class DropDownListContentControl 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; + trackRevisions: boolean; /** - * Gets the collection of list items in the dropdown list content control. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listItems: Word.ContentControlListItemCollection; + trackedChangesAreDateAndTimeRemoved: boolean; /** - * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApi 1.9] - * - * @param displayText - Required. Display text of the list item. - * @param value - Optional. Value of the list item. - * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + readonly type: Word.DocumentType | "Document" | "Template" | "Frameset"; /** - * Deletes all list items in this dropdown list content control. + * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteAllListItems(): void; + writePassword: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DropDownListContentControl; + xmlAreAdvancedErrorsShown: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DropDownListContentControl; + xmlIsXsltUsedWhenSaving: boolean; /** - * 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. + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.DropDownListContentControl; + xmlSaveThroughXSLT: string; /** - * 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. + * 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. */ - 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. - */ - toJSON(): Word.Interfaces.DropDownListContentControlData; - } - /** - * The data specific to content controls of type 'ComboBox'. - * - * @remarks - * [Api set: WordApi 1.9] - */ - export class ComboBoxContentControl 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; + set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Document): void; /** - * Gets the collection of list items in the combo box content control. + * Accepts all tracked changes in the document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listItems: Word.ContentControlListItemCollection; + acceptAllRevisions(): void; /** - * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * Accepts all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi 1.9] - * - * @param displayText - Required. Display text of the list item. - * @param value - Optional. Value of the list item. - * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + acceptAllRevisionsShown(): void; /** - * Deletes all list items in this combo box content control. + * Activates the document so that it becomes the active document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteAllListItems(): void; + activate(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds a style into the document by name and type. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ComboBoxContentControl; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.5] * - * @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.ComboBoxContentControl; - /** - * 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. + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. */ - track(): Word.ComboBoxContentControl; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * 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. + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. */ - 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. - */ - toJSON(): Word.Interfaces.ComboBoxContentControlData; - } - /** - * Represents a field. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - export class Field 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; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Gets a `LinkFormat` object that represents the link options of the field. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly linkFormat: Word.LinkFormat; + addToFavorites(): void; /** - * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. + * Applies the specified Quick Style set to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style - The style set to apply. */ - readonly oleFormat: Word.OleFormat; + applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void; /** - * Gets the parent body of the field. + * Applies the specified Quick Style set to the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param style - The style set to apply. */ - readonly parentBody: Word.Body; + applyQuickStyleSet(style: "SessionStart" | "Template"): void; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Applies the specified theme to this document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - The name of the theme. */ - readonly parentContentControl: Word.ContentControl; + applyTheme(name: string): void; /** - * 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}. + * Automatically formats the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentContentControlOrNullObject: Word.ContentControl; + autoFormat(): void; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Returns `true` if Microsoft Word can check in the document to a server. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns `true` if the document can be checked in; otherwise, `false`. */ - readonly parentTable: Word.Table; + canCheckin(): OfficeExtension.ClientResult; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTableCell: Word.TableCell; + checkConsistencyJapanese(): void; /** - * 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}. + * Begins a spelling and grammar check for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTableCellOrNullObject: Word.TableCell; + checkGrammar(): void; /** - * 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}. + * Checks in the document from the local computer to a server and sets the local document to read-only so that it cannot be edited locally. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for checking in the document. */ - readonly parentTableOrNullObject: Word.Table; + checkIn(options?: Word.DocumentCheckInOptions): void; /** - * Gets the field's result data. + * Saves the document to a server from a local computer, and sets the local document to read-only so that it cannot be edited locally. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for checking in the document with version control. */ - readonly result: Word.Range; + checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void; /** - * Specifies the field's code instruction. + * Begins a spelling check for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @param options - Optional. Configuration options for the spell checking operation. */ - code: string; + checkSpelling(options?: Word.DocumentCheckSpellingOptions): void; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] + * + * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. */ - data: string; + close(closeBehavior?: Word.CloseBehavior): void; /** - * Gets the field's kind. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] + * + * @param closeBehavior - Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. */ - readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + close(closeBehavior?: "Save" | "SkipSave"): void; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Switches the document from print preview to the previous view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked: boolean; + closePrintPreview(): void; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Displays revision marks that indicate where the specified document differs from another document. * * @remarks * [Api set: WordApiDesktop 1.1] + * + * @param filePath - Required. The path of the document with which the specified document is compared. + * @param documentCompareOptions - Optional. The additional options that specifies the behavior of comparing document. */ - showCodes: boolean; + compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Gets the field's type. + * Displays revision marks that indicate where the specified document differs from another document. * * @remarks - * [Api set: WordApi 1.5] - */ - readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; - /** - * 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. + * [Api set: WordApiDesktop 1.2] + * + * @param base64File - Required. The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions - Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. */ - set(properties: Interfaces.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Field): void; + compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Copies the field to the Clipboard. + * Returns a statistic based on the contents of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param statistic - The type of statistic to return. + * @param includeFootnotesAndEndnotes - Optional. Whether to include footnotes and endnotes. The default value is `false`. */ - copyToClipboard(): void; + computeStatistics(statistic: Word.Statistic, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; /** - * Removes the field from the document and places it on the Clipboard. + * Returns a statistic based on the contents of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param statistic - The type of statistic to return. + * @param includeFootnotesAndEndnotes - Optional. Whether to include footnotes and endnotes. The default value is `false`. */ - cut(): void; + computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; /** - * Deletes the field. + * Converts the file to the newest format and enables all features. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + convert(): void; /** - * Clicks the field. + * Converts automatic hyphens to manual hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doClick(): void; + convertAutoHyphens(): void; /** - * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType - Optional. The type of numbering to convert. */ - getNext(): Word.Field; + convertNumbersToText(numberType?: Word.NumberType): void; /** - * Gets the next field. If this field is the last one, 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}. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType - Optional. The type of numbering to convert. */ - getNextOrNullObject(): Word.Field; + convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Selects the field. + * Reconverts a Vietnamese document to Unicode using a code page other than the default. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param codePageOrigin - The code page to use. */ - select(selectionMode?: Word.SelectionMode): void; + convertVietnameseDocument(codePageOrigin: number): void; /** - * Selects the field. + * Copies styles from the specified template to the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param StyleTemplate - The template to copy styles from. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + copyStylesFromTemplate(StyleTemplate: string): void; /** - * Replaces the field with its most recent result. + * Returns the number of bulleted or numbered items and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Configuration options for counting numbered items. + * @returns The count of numbered items. */ - unlink(): void; + countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Updates the field. + * Deletes all comments from the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - updateResult(): void; + deleteAllComments(): void; /** - * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. + * Deletes all revisions in the document that are displayed on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - updateSource(): void; + deleteAllCommentsShown(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes all handwritten ink annotations in the document. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; + deleteAllInkAnnotations(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes a bookmark, if it exists, from the document. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.4] + * + * @param name - Required. The case-insensitive bookmark name. */ - load(propertyNames?: string | string[]): Word.Field; + deleteBookmark(name: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Analyzes the document text to determine the language. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Field; + detectLanguage(): void; /** - * 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. + * Terminates a review of the file that has been sent for review. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for ending the review process. */ - track(): Word.Field; + endReview(options?: Word.DocumentEndReviewOptions): void; /** - * 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. + * Saves the document in PDF or XPS format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName - The name of the output file. + * @param exportFormat - The export format. + * @param options - Optional. Configuration options for the export operation. */ - untrack(): Word.Field; + exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Saves the document in PDF or XPS format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName - The name of the output file. + * @param exportFormat - The export format. + * @param options - Optional. Configuration options for the export operation. */ - toJSON(): Word.Interfaces.FieldData; - } - /** - * Contains a collection of {@link Word.Field} objects. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - export class FieldCollection 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.Field[]; + exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void; /** - * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Saves the document in PDF or XPS format. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName - The output file name. + * @param exportFormat - The format to export (PDF/XPS). + * @param options - Optional. Configuration options for the export operation. */ - getFirst(): Word.Field; + exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void; /** - * Gets the first field 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}. + * Saves the document in PDF or XPS format. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName - The output file name. + * @param exportFormat - The format to export (PDF/XPS). + * @param options - Optional. Configuration options for the export operation. */ - getFirstOrNullObject(): Word.Field; + exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void; /** - * Gets the Field object collection including the specified types of fields. + * Saves the document in PDF or XPS format with improved tagging. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param types - Required. An array of field types. + * @param outputFileName - The output file name. + * @param exportFormat - The format to export (PDF/XPS). + * @param options - Optional. Configuration options for the export operation. */ - getByTypes(types: Word.FieldType[]): Word.FieldCollection; + exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Saves the document in PDF or XPS format with improved tagging. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName - The output file name. + * @param exportFormat - The format to export (PDF/XPS). + * @param options - Optional. Configuration options for the export operation. */ - load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; + exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Decreases the font size of text just enough so that the document page count drops by one. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.FieldCollection; + fitToPages(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Displays a cached document, if it has already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for following the hyperlink. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; + followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void; /** - * 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. + * Fixes the layout of the document in Web view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.FieldCollection; + freezeLayout(): void; /** - * 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. + * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param id - The ID of the annotation to get. */ - untrack(): Word.FieldCollection; + getAnnotationById(id: string): 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.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. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param name - Required. The case-insensitive bookmark name. */ - toJSON(): Word.Interfaces.FieldCollectionData; - } - /** - * Represents a font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export class Font 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; + getBookmarkRange(name: string): Word.Range; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Gets a bookmark's range. If the bookmark doesn't exist, 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 + * [Api set: WordApi 1.4] + * + * @param name - Required. The case-insensitive bookmark name. */ - readonly borders: Word.BorderUniversalCollection; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Gets the currently supported content controls in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. */ - readonly fill: Word.FillFormat; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param referenceType - The type of reference. */ - readonly glow: Word.GlowFormat; + getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param referenceType - The type of reference. */ - readonly line: Word.LineFormat; + getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Gets the document's endnotes in a single body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly reflection: Word.ReflectionFormat; + getEndnoteBody(): Word.Body; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Gets the document's footnotes in a single body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly textColor: Word.ColorFormat; + getFootnoteBody(): Word.Body; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + * + * @param id - Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. */ - readonly textShadow: Word.ShadowFormat; + getParagraphByUniqueLocalId(id: string): Word.Paragraph; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Returns a `Range` object by using the specified starting and ending character positions. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Configuration options for specifying the range parameters. */ - readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; + getRange(options?: Word.DocumentRangeOptions): Word.Range; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets the current selection of the document. Multiple selections aren't supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - allCaps: boolean; + getSelection(): Word.Range; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a StyleCollection object that represents the whole style set of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - bold: boolean; + getStyles(): Word.StyleCollection; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Returns a `Range` object that represents the start position of the specified item, such as a page, bookmark, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Configuration options for specifying the `goTo` parameters. */ - boldBidirectional: boolean; + goTo(options?: Word.GoToOptions): Word.Range; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson - Required. A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. */ - color: string; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson - Required. A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. */ - colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * 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'. + * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. */ - colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * Specifies whether contextual alternates are enabled for the font. + * Locks the file on the server preventing anyone else from editing it. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates: boolean; + lockServerFile(): void; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Sets the compatibility options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor: string; + makeCompatibilityDefault(): void; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Initiates manual hyphenation of a document, one line at a time. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid: boolean; + manualHyphenation(): void; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Merges the changes marked with revision marks from one document to another. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param fileName - The name of the file to merge. + * @param options - Optional. Configuration options for the merge operation. */ - doubleStrikeThrough: boolean; + merge(fileName: string, options?: Word.DocumentMergeOptions): void; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Posts the document to a public folder in Microsoft Exchange. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss: boolean; + post(): void; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Opens PowerPoint with the Word document loaded. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + presentIt(): void; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Prints all or part of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Configuration options for the print operation. */ - engrave: boolean; + printOut(options?: Word.DocumentPrintOutOptions): void; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Switches the view to print preview. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden: boolean; + printPreview(): void; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Protects the document from unauthorized changes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of protection. + * @param options - Optional. Configuration options for document protection. */ - highlightColor: string; + protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Protects the document from unauthorized changes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of protection. + * @param options - Optional. Configuration options for document protection. */ - italic: boolean; + protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Redoes the last action that was undone (reverses the `undo` method). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param times - Optional. The number of actions to redo. + * @returns `true` if the actions were redone successfully; otherwise, `false`. */ - italicBidirectional: boolean; + redo(times?: number): OfficeExtension.ClientResult; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Rejects all tracked changes in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning: number; + rejectAllRevisions(): void; /** - * Specifies the ligature setting for the `Font` object. + * Rejects all revisions in the document that are displayed on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + rejectAllRevisionsShown(): void; /** - * Specifies a value that represents the name of the font. + * Reloads a cached document by resolving the hyperlink to the document and downloading it. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name: string; + reload(): void; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Reloads the document based on an HTML document, using the document encoding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param encoding - The encoding to use. */ - nameAscii: string; + reloadAs(encoding: Word.DocumentEncoding): void; /** - * Specifies the font name in a right-to-left language document. + * Reloads the document based on an HTML document, using the document encoding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param encoding - The encoding to use. */ - nameBidirectional: string; + reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void; /** - * Specifies the East Asian font name. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param removeDocInfoType - The type of document info to remove. */ - nameFarEast: string; + removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void; /** - * Specifies the font used for characters with codes from 128 through 255. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param removeDocInfoType - The type of document info to remove. */ - nameOther: string; + removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void; /** - * Specifies the number form setting for an OpenType font. + * Purges the document of locked styles when formatting restrictions have been applied in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + removeLockedStyles(): void; /** - * Specifies the number spacing setting for the font. + * Removes numbers or bullets from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of numbering to remove. */ - numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + removeNumbers(numberType?: Word.NumberType): void; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Removes numbers or bullets from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of numbering to remove. */ - outline: boolean; + removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Specifies the position of text (in points) relative to the base line. + * Removes the active theme from the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position: number; + removeTheme(): void; /** - * Specifies the scaling percentage applied to the font. + * Repaginates the entire document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling: number; + repaginate(): void; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Sends an email message to the author of the document that has been sent out for review, notifying them that a reviewer has completed review of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Configuration options for replying with changes. */ - shadow: boolean; + replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void; /** - * Specifies a value that represents the font size in points. + * Clears all form fields in the document, preparing the form to be filled in again. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size: number; + resetFormFields(): void; /** - * Specifies the font size in points for right-to-left text. + * Returns the document to the last saved reading position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional: number; + returnToLastReadPosition(): OfficeExtension.ClientResult; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param autoMacro - The auto macro to run. */ - smallCaps: boolean; + runAutoMacro(autoMacro: Word.AutoMacro): void; /** - * Specifies the spacing between characters. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param autoMacro - The auto macro to run. */ - spacing: number; + runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Saves the document. * * @remarks * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. */ - strikeThrough: boolean; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Specifies the stylistic set for the font. + * Saves the document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior - Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + /** + * Saves the group of quick styles currently in use. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param fileName - The name of the file to save. */ - stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + saveAsQuickStyleSet(fileName: string): void; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - subscript: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Selects the contents of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - superscript: boolean; + select(): void; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Returns all content controls with the specified tag. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param tag - The tag value to filter content controls. */ - underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + selectContentControlsByTag(tag: string): Word.ContentControlCollection; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ContentControlCollection` object that represents all the content controls in the document with the specified title. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param title - The title of the content controls. */ - underlineColor: string; + selectContentControlsByTitle(title: string): Word.ContentControlCollection; /** - * 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. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are linked to the specific custom XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param node - The custom XML node. */ - set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Font): void; + selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection; /** - * Decreases the font size to the next available size. + * Returns an `XmlNodeCollection` object that represents all the nodes that match the XPath parameter in the order in which they appear in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xPath - The XPath expression. + * @param options - Optional. Configuration options for the nodes selection. */ - decreaseFontSize(): void; + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** - * Increases the font size to the next available size. + * Returns an `XmlNode` object that represents the first node that matches the XPath parameter in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xPath - The XPath expression. + * @param options - Optional. Configuration options for the node selection. */ - increaseFontSize(): void; + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * Removes manual character formatting. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are not linked to an XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param stream - Optional. The custom XML part. */ - reset(): void; + selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection; /** - * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * Sends the document as a fax, without any user interaction. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param address - The fax address. + * @param subject - Optional. The subject of the fax. */ - setAsTemplateDefault(): void; + sendFax(address: string, subject?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sends the document to a fax service provider, who faxes the document to one or more specified recipients. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for sending the fax over the internet. */ - load(options?: Word.Interfaces.FontLoadOptions): Word.Font; + sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sends the document in an email message for review by the specified recipients. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Configuration options for sending the document for review. */ - load(propertyNames?: string | string[]): Word.Font; + sendForReview(options?: Word.DocumentSendForReviewOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Opens a message window for sending the document through Microsoft Exchange. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Font; + sendMail(): void; /** - * 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. + * Specifies the table style to use for newly created tables in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param style - The style to apply. + * @param setInTemplate - Whether to set the style in the template. */ - track(): Word.Font; + setDefaultTableStyle(style: string, setInTemplate: boolean): void; /** - * 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. + * Sets the options Microsoft Word uses for encrypting documents with passwords. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param passwordEncryptionProvider - The encryption provider. + * @param passwordEncryptionAlgorithm - The encryption algorithm. + * @param passwordEncryptionKeyLength - The key length. + * @param passwordEncryptFileProperties - Optional. Whether to encrypt file properties. */ - untrack(): Word.Font; + setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Switches form design mode on or off. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.FontData; - } - /** - * Represents a heading style used in a table of contents or table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class HeadingStyle 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; + toggleFormsDesign(): void; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param path - The path to the XSLT file. + * @param dataOnly - Optional. Whether to use data only. */ - level: number; + transformDocument(path: string, dataOnly?: boolean): void; /** - * Specifies the name of style for a heading. + * Undoes the last action or a sequence of actions, which are displayed in the Undo list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param times - Optional. The number of actions to undo. + * @returns `true` if the actions were undone successfully; otherwise, `false`. */ - name: string; + undo(times?: number): OfficeExtension.ClientResult; /** - * 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. + * Clears the list of actions that can be undone in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.HeadingStyle): void; + undoClear(): void; /** - * Deletes the heading style. + * Removes protection from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param password - Optional. The password to unprotect the document. */ - delete(): void; + unprotect(password?: string): void; + /** + * Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + updateStyles(): void; + /** + * Displays the code window for the selected Microsoft ActiveX control in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + viewCode(): void; + /** + * Displays the property window for the selected Microsoft ActiveX control in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + viewPropertyBrowser(): void; + /** + * Displays a preview of the current document as it would look if saved as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + webPagePreview(): 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.HeadingStyleLoadOptions): Word.HeadingStyle; + load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; /** * 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.HeadingStyle; + load(propertyNames?: string | string[]): Word.Document; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -8551,603 +8773,533 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.HeadingStyle; + }): Word.Document; /** - * 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. + * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - track(): Word.HeadingStyle; + readonly onAnnotationClicked: OfficeExtension.EventHandlers; /** - * 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. + * Occurs when the user hovers the cursor over an annotation. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - untrack(): Word.HeadingStyle; + readonly onAnnotationHovered: OfficeExtension.EventHandlers; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. + * Occurs when the user adds one or more annotations. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - toJSON(): Word.Interfaces.HeadingStyleData; - } - /** - * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class HeadingStyleCollection 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.HeadingStyle[]; + readonly onAnnotationInserted: OfficeExtension.EventHandlers; /** - * Adds a new heading style to a document. + * Occurs when the user performs an action in an annotation pop-up menu. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.8] * - * @param name - The style name to be added. - * @param level - The heading level to assign. Must be a value from 1 to 9. - * @returns The new `HeadingStyle` object that was added to the collection. + * @eventproperty */ - add(name: string, level: number): Word.HeadingStyle; + readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user deletes one or more annotations. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; + readonly onAnnotationRemoved: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty */ - load(propertyNames?: string | string[]): Word.HeadingStyleCollection; + readonly onContentControlAdded: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user adds new paragraphs. * - * @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. + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HeadingStyleCollection; + readonly onParagraphAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the user changes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the user deletes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphDeleted: OfficeExtension.EventHandlers; /** * 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.HeadingStyleCollection; + track(): Word.Document; /** * 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.HeadingStyleCollection; + 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.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.HeadingStyleCollectionData; + toJSON(): Word.Interfaces.DocumentData; } /** - * Represents a hyperlink in a Word document. + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export class Hyperlink extends OfficeExtension.ClientObject { + export class DocumentCreated 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; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly range: Word.Range; + readonly body: Word.Body; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - address: string; + readonly contentControls: Word.ContentControlCollection; /** - * Specifies the text string for the hyperlink's subject line. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] */ - emailSubject: string; + readonly customXmlParts: Word.CustomXmlPartCollection; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly isExtraInfoRequired: boolean; + readonly properties: Word.DocumentProperties; /** - * Returns the name of the `Hyperlink` object. + * Gets the collection of section objects in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly name: string; + readonly sections: Word.SectionCollection; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the add-in's settings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] */ - screenTip: string; + readonly settings: Word.SettingCollection; /** - * Specifies a named location in the destination of the hyperlink. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - subAddress: string; + readonly saved: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - target: string; + set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentCreated): void; /** - * Specifies the hyperlink's visible text in the document. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. */ - textToDisplay: string; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * Returns the hyperlink type. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - /** - * 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. + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name - Required. A string representing the style name. + * @param type - Required. The style type, including character, list, paragraph, or table. */ - set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Hyperlink): void; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. + * Deletes a bookmark, if it exists, from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name - Required. The case-insensitive bookmark name. */ - addToFavorites(): void; + deleteBookmark(name: string): void; /** - * Creates a new document linked to the hyperlink. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] * - * @param fileName - Required. The name of the file. - * @param editNow - Required. `true` to start editing now. - * @param overwrite - Required. `true` to overwrite if there's another file with the same name. + * @param name - Required. The case-insensitive bookmark name. */ - createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; + getBookmarkRange(name: string): Word.Range; /** - * Deletes the hyperlink. + * Gets a bookmark's range. If the bookmark doesn't exist, 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 - */ - delete(): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApiHiddenDocument 1.4] * - * @param options - Provides options for which properties of the object to load. + * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the currently supported content controls in the document. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. */ - load(propertyNames?: string | string[]): Word.Hyperlink; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets a StyleCollection object that represents the whole style set of the document. * - * @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. + * @remarks + * [Api set: WordApiHiddenDocument 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Hyperlink; + getStyles(): Word.StyleCollection; /** - * 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. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * 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'. + * @param insertFileOptions - Optional. The additional properties that should be imported to the destination document. */ - track(): Word.Hyperlink; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * 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. + * Opens the document. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.Hyperlink; + open(): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + * Saves the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. */ - toJSON(): Word.Interfaces.HyperlinkData; - } - /** - * Contains a collection of {@link Word.Hyperlink} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class HyperlinkCollection 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.Hyperlink[]; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. + * Saves the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] * - * @param anchor - Required. The range to which the hyperlink is added. - * @param options - Optional. The options to further configure the new hyperlink. + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior - Optional. DocumentCreated only supports 'Save'. + * @param fileName - Optional. The file name (exclude file extension). Only takes effect for a new document. */ - add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; + save(saveBehavior?: "Save" | "Prompt", fileName?: string): 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.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; + load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; /** * 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.HyperlinkCollection; + load(propertyNames?: string | string[]): Word.DocumentCreated; /** * 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.HyperlinkCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentCreated; /** * 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.HyperlinkCollection; + track(): Word.DocumentCreated; /** * 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.HyperlinkCollection; + 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.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.HyperlinkCollectionData; + toJSON(): Word.Interfaces.DocumentCreatedData; } /** - * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. + * Represents document properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export interface HyperlinkAddOptions { + export class DocumentProperties 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; /** - * If provided, specifies the address (e.g., URL or file path) of the hyperlink. + * Gets the collection of custom properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - address?: string; + readonly customProperties: Word.CustomPropertyCollection; /** - * If provided, specifies the text that appears as a tooltip. + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - screenTip?: string; + readonly applicationName: string; /** - * If provided, specifies the location within the file or document. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - subAddress?: string; + author: string; /** - * If provided, specifies the name of the frame or window in which to load the hyperlink. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - target?: string; + category: string; /** - * If provided, specifies the visible text of the hyperlink. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textToDisplay?: string; - } - /** - * Represents an inline picture. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export class InlinePicture 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; + comments: string; /** - * Gets the parent paragraph that contains the inline image. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - readonly paragraph: Word.Paragraph; + company: string; /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly parentContentControl: Word.ContentControl; + readonly creationDate: Date; /** - * 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}. + * Specifies the format of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + format: string; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies the keywords of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTable: Word.Table; + keywords: string; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the last author of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableCell: Word.TableCell; + readonly lastAuthor: string; /** - * 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}. + * Gets the last print date of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableCellOrNullObject: Word.TableCell; + readonly lastPrintDate: Date; /** - * 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}. + * Gets the last save time of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableOrNullObject: Word.Table; - /** - * Specifies a string that represents the alternative text associated with the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - altTextDescription: string; + readonly lastSaveTime: Date; /** - * Specifies a string that contains the title for the inline image. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - altTextTitle: string; + manager: string; /** - * Specifies a number that describes the height of the inline image. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - height: number; + readonly revisionNumber: string; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - hyperlink: string; + readonly security: number; /** - * Gets the format of the inline image. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + subject: string; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the template of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + readonly template: string; /** - * Specifies a number that describes the width of the inline image. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - width: number; + title: string; /** * 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.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.InlinePicture): void; - /** - * Deletes the inline picture from the document. - * - * @remarks - * [Api set: WordApi 1.2] - */ - delete(): void; - /** - * Gets the Base64-encoded string representation of the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - getBase64ImageSrc(): OfficeExtension.ClientResult; - /** - * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.InlinePicture; - /** - * Gets the next inline image. If this inline image is the last one, 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] - */ - getNextOrNullObject(): Word.InlinePicture; - /** - * Gets the picture, or the starting or ending point of the picture, as a range. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', or 'End'. - */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; - /** - * Inserts a break at the specified location in the main document. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param breakType - Required. The break type to add. - * @param insertLocation - Required. The value must be 'Before' or 'After'. - */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + set(properties: Word.DocumentProperties): void; /** - * Wraps the inline picture with a rich text content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param options - Provides options for which properties of the object to load. */ - insertContentControl(): Word.ContentControl; + load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; /** - * Inserts a document at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * 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. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64File - Required. The Base64-encoded content of a .docx file. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + load(propertyNames?: string | string[]): Word.DocumentProperties; /** - * Inserts HTML at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param html - Required. The HTML to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @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. */ - insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentProperties; /** - * Inserts an inline picture at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Before', or 'After'. + * 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. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; + track(): Word.DocumentProperties; /** - * Inserts OOXML at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param ooxml - Required. The OOXML to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * 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. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + untrack(): Word.DocumentProperties; /** - * Inserts a paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param paragraphText - Required. The paragraph text to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + toJSON(): Word.Interfaces.DocumentPropertiesData; + } + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export class DropDownListContentControl 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; /** - * Inserts text at the specified location. + * Gets the collection of list items in the dropdown list content control. * * @remarks - * [Api set: WordApi 1.2] - * - * @param text - Required. Text to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.9] */ - insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + readonly listItems: Word.ContentControlListItemCollection; /** - * Selects the inline picture. This causes Word to scroll to the selection. + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.9] * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - select(selectionMode?: Word.SelectionMode): void; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Selects the inline picture. This causes Word to scroll to the selection. + * Deletes all list items in this dropdown list content control. * * @remarks - * [Api set: WordApi 1.2] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. - */ - select(selectionMode?: "Select" | "Start" | "End"): 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. + * [Api set: WordApi 1.9] */ - load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; + deleteAllListItems(): void; /** * 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.InlinePicture; + load(propertyNames?: string | string[]): Word.DropDownListContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -9156,397 +9308,319 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.InlinePicture; + }): Word.DropDownListContentControl; /** * 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.InlinePicture; + track(): Word.DropDownListContentControl; /** * 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.InlinePicture; + 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.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; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * The data specific to content controls of type 'ComboBox'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.9] */ - export class InlinePictureCollection extends OfficeExtension.ClientObject { + export class ComboBoxContentControl 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.InlinePicture[]; /** - * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the collection of list items in the combo box content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - getFirst(): Word.InlinePicture; + readonly listItems: Word.ContentControlListItemCollection; /** - * Gets the first inline image 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}. + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] + * + * @param displayText - Required. Display text of the list item. + * @param value - Optional. Value of the list item. + * @param index - Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - getFirstOrNullObject(): Word.InlinePicture; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes all list items in this combo box content control. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.9] */ - load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; + deleteAllListItems(): void; /** * 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.InlinePictureCollection; + load(propertyNames?: string | string[]): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + track(): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + 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.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; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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; } /** - * Represents the linking characteristics for an OLE object or picture. + * Represents a field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - export class LinkFormat extends OfficeExtension.ClientObject { + export class Field 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; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated: boolean; + readonly linkFormat: Word.LinkFormat; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked: boolean; + readonly oleFormat: Word.OleFormat; /** - * Specifies if the linked picture is saved with the document. + * Gets the parent body of the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isPictureSavedWithDocument: boolean; + readonly parentBody: Word.Body; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sourceFullName: string; + readonly parentContentControl: Word.ContentControl; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly sourceName: string; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly sourcePath: string; + readonly parentTable: Word.Table; /** - * Gets the link type. + * 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 BETA (PREVIEW ONLY)] - * @beta - */ - readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - /** - * 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. + * [Api set: WordApi 1.4] */ - set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LinkFormat): void; + readonly parentTableCell: Word.TableCell; /** - * Breaks the link between the source file and the OLE object, picture, or linked field. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - breakLink(): void; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.4] */ - load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the field's result data. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.4] */ - load(propertyNames?: string | string[]): Word.LinkFormat; + readonly result: Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the field's code instruction. * - * @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.LinkFormat; - /** - * 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. + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - track(): Word.LinkFormat; + code: string; /** - * 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. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.LinkFormat; + data: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LinkFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LinkFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] */ - toJSON(): Word.Interfaces.LinkFormatData; - } - /** - * Contains a collection of {@link Word.Paragraph} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class List 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; + readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Gets paragraphs in the list. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - readonly paragraphs: Word.ParagraphCollection; + locked: boolean; /** - * Gets the list's id. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly id: number; + showCodes: boolean; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Gets the field's type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - readonly levelExistences: boolean[]; + readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * 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.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Field): void; + /** + * Copies the field to the Clipboard. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly levelTypes: Word.ListLevelType[]; + copyToClipboard(): void; /** - * Gets the font of the bullet, number, or picture at the specified level in the list. + * Removes the field from the document and places it on the Clipboard. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level - Required. The level in the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLevelFont(level: number): Word.Font; + cut(): void; /** - * Gets the paragraphs that occur at the specified level in the list. + * Deletes the field. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. + * [Api set: WordApi 1.5] */ - getLevelParagraphs(level: number): Word.ParagraphCollection; + delete(): void; /** - * Gets the Base64-encoded string representation of the picture at the specified level in the list. + * Clicks the field. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level - Required. The level in the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLevelPicture(level: number): OfficeExtension.ClientResult; + doClick(): void; /** - * Gets the bullet, number, or picture at the specified level as a string. + * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. + * [Api set: WordApi 1.4] */ - getLevelString(level: number): OfficeExtension.ClientResult; + getNext(): Word.Field; /** - * Inserts a paragraph at the specified location. + * Gets the next field. If this field is the last one, 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] - * - * @param paragraphText - Required. The paragraph text to be inserted. - * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. + * [Api set: WordApi 1.4] */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; + getNextOrNullObject(): Word.Field; /** - * Resets the font of the bullet, number, or picture at the specified level in the list. + * Selects the field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] * - * @param level - Required. The level in the list. - * @param resetFontName - Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - resetLevelFont(level: number, resetFontName?: boolean): void; + select(selectionMode?: Word.SelectionMode): void; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Selects the field. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] * - * @param level - Required. The level in the list. - * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - setLevelAlignment(level: number, alignment: Word.Alignment): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Replaces the field with its most recent result. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; + unlink(): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Updates the field. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param listBullet - Required. The bullet. - * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. + * [Api set: WordApi 1.5] */ - setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; + updateResult(): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param listBullet - Required. The bullet. - * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. - */ - setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; - /** - * Sets the two indents of the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param textIndent - Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent - Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. - */ - setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; - /** - * Sets the numbering format at the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param listNumbering - Required. The ordinal format. - * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. - */ - setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; - /** - * Sets the numbering format at the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param listNumbering - Required. The ordinal format. - * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. - */ - setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; - /** - * Sets the picture at the specified level in the list. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level - Required. The level in the list. - * @param base64EncodedImage - Optional. The Base64-encoded image to be set. If not given, the default picture is set. - */ - setLevelPicture(level: number, base64EncodedImage?: string): void; - /** - * Sets the starting number at the specified level in the list. Default value is 1. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level - Required. The level in the list. - * @param startingNumber - Required. The number to start with. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setLevelStartingNumber(level: number, startingNumber: number): void; + updateSource(): 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.ListLoadOptions): Word.List; + load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; /** * 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.List; + load(propertyNames?: string | string[]): Word.Field; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -9555,442 +9629,572 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.List; + }): Word.Field; /** * 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.List; + track(): Word.Field; /** * 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.List; + 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.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. + * 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.ListData; + toJSON(): Word.Interfaces.FieldData; } /** - * Contains a collection of {@link Word.List} objects. + * Contains a collection of {@link Word.Field} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - export class ListCollection extends OfficeExtension.ClientObject { + export class FieldCollection 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.List[]; - /** - * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param id - Required. A list identifier. - */ - getById(id: number): Word.List; - /** - * Gets a list by its identifier. If there isn't a list 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 1.3] - * - * @param id - Required. A list identifier. - */ - getByIdOrNullObject(id: number): Word.List; + readonly items: Word.Field[]; /** - * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - getFirst(): Word.List; + getFirst(): Word.Field; /** - * Gets the first list 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}. + * Gets the first field 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 1.3] + * [Api set: WordApi 1.4] */ - getFirstOrNullObject(): Word.List; + getFirstOrNullObject(): Word.Field; /** - * Gets a list object by its ID. + * Gets the Field object collection including the specified types of fields. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] * - * @param id - The list's ID. + * @param types - Required. An array of field types. */ - getItem(id: number): Word.List; + getByTypes(types: Word.FieldType[]): Word.FieldCollection; /** * 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.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; + load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; /** * 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.ListCollection; + load(propertyNames?: string | string[]): Word.FieldCollection; /** * 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.ListCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; /** * 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.ListCollection; + track(): Word.FieldCollection; /** * 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.ListCollection; + 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.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. + * 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.ListCollectionData; + toJSON(): Word.Interfaces.FieldCollectionData; } /** - * Represents the paragraph list item format. + * Represents a font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - export class ListItem extends OfficeExtension.ClientObject { + export class Font 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; /** - * Specifies the level of the item in the list. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level: number; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the list item bullet, number, or picture as a string. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listString: string; + readonly fill: Word.FillFormat; /** - * Gets the list item order number in relation to its siblings. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.3] - */ - readonly siblingIndex: 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListItem): void; + readonly glow: Word.GlowFormat; /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAncestor(parentOnly?: boolean): Word.Paragraph; + readonly line: Word.LineFormat; /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, 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}. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; + readonly reflection: Word.ReflectionFormat; /** - * Gets all descendant list items of the list item. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApi 1.3] - * - * @param directChildrenOnly - Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; + readonly textColor: Word.ColorFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; + readonly textShadow: Word.ShadowFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListItem; + readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * - * @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.ListItem; - /** - * 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.ListItem; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListItemData; - } - /** - * Represents a list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export class ListLevel 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; + allCaps: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - readonly font: Word.Font; + bold: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + boldBidirectional: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - linkedStyle: string; + color: string; /** - * Specifies the number format for the specified list level. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat: string; + colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition: number; + colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the number style for the list level object. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + contextualAlternates: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher: number; + diacriticColor: string; /** - * Specifies the starting number for the specified list level object. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt: number; + disableCharacterSpaceGrid: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - tabPosition: number; + doubleStrikeThrough: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition: number; + emboss: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListLevel): void; + emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; + engrave: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ListLevel; + hidden: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * @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.ListLevel; - /** - * 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.ListLevel; - /** - * 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. + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.ListLevel; + highlightColor: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.ListLevelData; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export class ListLevelCollection 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.ListLevel[]; + italic: boolean; /** - * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.ListLevel; + italicBidirectional: boolean; /** - * Gets the first list level 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}. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.ListLevel; + kerning: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the ligature setting for the `Font` object. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; + ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that represents the name of the font. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(propertyNames?: string | string[]): Word.ListLevelCollection; + name: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection; + nameAscii: string; /** - * 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. + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ListLevelCollection; + nameBidirectional: string; /** - * 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. + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ListLevelCollection; + nameFarEast: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListLevelCollectionData; - } - /** - * Represents a list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export class ListTemplate 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; + nameOther: string; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listLevels: Word.ListLevelCollection; + numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * Specifies the name of the list template. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name: string; + numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Specifies whether the list template is outline numbered. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered: boolean; + outline: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor: string; /** * 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.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListTemplate): void; + set(properties: Word.Font): void; + /** + * Decreases the font size to the next available size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decreaseFontSize(): void; + /** + * Increases the font size to the next available size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + increaseFontSize(): void; + /** + * Removes manual character formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reset(): void; + /** + * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setAsTemplateDefault(): 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.ListTemplateLoadOptions): Word.ListTemplate; + load(options?: Word.Interfaces.FontLoadOptions): Word.Font; /** * 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.ListTemplate; + load(propertyNames?: string | string[]): Word.Font; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -9999,92 +10203,75 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ListTemplate; + }): Word.Font; /** * 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.ListTemplate; + track(): Word.Font; /** * 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.ListTemplate; + 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.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. + * 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.ListTemplateData; + toJSON(): Word.Interfaces.FontData; } /** - * Represents a footnote or endnote. + * Represents a heading style used in a table of contents or table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class NoteItem extends OfficeExtension.ClientObject { + export class HeadingStyle 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 note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - readonly body: Word.Body; - /** - * Represents a footnote or endnote reference in the main document. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly reference: Word.Range; + level: number; /** - * Represents the note item type: footnote or endnote. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.NoteItemType | "Footnote" | "Endnote"; + name: string; /** * 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.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.NoteItem): void; + set(properties: Word.HeadingStyle): void; /** - * Deletes the note item. + * Deletes the heading style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ delete(): void; - /** - * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. - * - * @remarks - * [Api set: WordApi 1.5] - */ - getNext(): Word.NoteItem; - /** - * Gets the next note item of the same type. If this note item is the last one, 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.5] - */ - getNextOrNullObject(): Word.NoteItem; /** * 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.NoteItemLoadOptions): Word.NoteItem; + load(options?: Word.Interfaces.HeadingStyleLoadOptions): Word.HeadingStyle; /** * 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.NoteItem; + load(propertyNames?: string | string[]): Word.HeadingStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -10093,234 +10280,215 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.NoteItem; + }): Word.HeadingStyle; /** * 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.NoteItem; + track(): Word.HeadingStyle; /** * 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.NoteItem; + untrack(): Word.HeadingStyle; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.NoteItemData; + toJSON(): Word.Interfaces.HeadingStyleData; } /** - * Contains a collection of {@link Word.NoteItem} objects. + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class NoteItemCollection extends OfficeExtension.ClientObject { + export class HeadingStyleCollection 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.NoteItem[]; + readonly items: Word.HeadingStyle[]; /** - * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Adds a new heading style to a document. * * @remarks - * [Api set: WordApi 1.5] - */ - getFirst(): Word.NoteItem; - /** - * Gets the first note item 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}. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.5] + * @param name - The style name to be added. + * @param level - The heading level to assign. Must be a value from 1 to 9. + * @returns The new `HeadingStyle` object that was added to the collection. */ - getFirstOrNullObject(): Word.NoteItem; + add(name: string, level: number): Word.HeadingStyle; /** * 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.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; + load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + load(propertyNames?: string | string[]): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + track(): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + untrack(): Word.HeadingStyleCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.NoteItemCollectionData; + toJSON(): Word.Interfaces.HeadingStyleCollectionData; } /** - * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * Represents a hyperlink in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class OleFormat extends OfficeExtension.ClientObject { + export class Hyperlink 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; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType: string; + readonly range: Word.Range; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex: number; + address: string; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel: string; + emailSubject: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName: string; + readonly isExtraInfoRequired: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly iconPath: string; + readonly name: string; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isDisplayedAsIcon: boolean; + screenTip: string; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate: boolean; + subAddress: string; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly label: string; + target: string; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly progID: string; - /** - * 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.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.OleFormat): void; + textToDisplay: string; /** - * Activates the `OleFormat` object. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - activate(): void; + readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; /** - * Sets the Windows registry value that determines the default application used to activate the specified OLE object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param classType - The class type to activate as. + * 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. */ - activateAs(classType: string): void; + set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Hyperlink): void; /** - * Requests that the OLE object perform one of its available verbs. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param verbIndex - Optional. The index of the verb to perform. */ - doVerb(verbIndex: Word.OleVerb): void; + addToFavorites(): void; /** - * Requests that the OLE object perform one of its available verbs. + * Creates a new document linked to the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param verbIndex - Optional. The index of the verb to perform. - */ - doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; - /** - * Opens the OLE object for editing in the application it was created in. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param fileName - Required. The name of the file. + * @param editNow - Required. `true` to start editing now. + * @param overwrite - Required. `true` to overwrite if there's another file with the same name. */ - edit(): void; + createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; /** - * Opens the `OleFormat` object. + * Deletes the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - open(): void; + delete(): 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.OleFormatLoadOptions): Word.OleFormat; + load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; /** * 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.OleFormat; + load(propertyNames?: string | string[]): Word.Hyperlink; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -10329,1707 +10497,1655 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.OleFormat; + }): Word.Hyperlink; /** * 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.OleFormat; + track(): Word.Hyperlink; /** * 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.OleFormat; + untrack(): Word.Hyperlink; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.OleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.OleFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.OleFormatData; + toJSON(): Word.Interfaces.HyperlinkData; } /** - * Represents a page in the document. `Page` objects manage the page layout and content. + * Contains a collection of {@link Word.Hyperlink} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class Page extends OfficeExtension.ClientObject { + export class HyperlinkCollection 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.Hyperlink[]; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly breaks: Word.BreakCollection; - /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly height: number; - /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly index: number; - /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly width: number; - /** - * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - getNext(): Word.Page; - /** - * Gets the next page. If this page is the last one, 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: WordApiDesktop 1.2] - */ - getNextOrNullObject(): Word.Page; - /** - * Gets the whole page, or the starting or ending point of the page, as a range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] * - * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param anchor - Required. The range to which the hyperlink is added. + * @param options - Optional. The options to further configure the new hyperlink. */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; /** * 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.PageLoadOptions): Word.Page; + load(options?: Word.Interfaces.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; /** * 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.Page; + load(propertyNames?: string | string[]): Word.HyperlinkCollection; /** * 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.Page; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HyperlinkCollection; /** * 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.Page; + track(): Word.HyperlinkCollection; /** * 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.Page; + untrack(): Word.HyperlinkCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.PageData; + toJSON(): Word.Interfaces.HyperlinkCollectionData; } /** - * Represents the collection of page. + * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class PageCollection 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.Page[]; + export interface HyperlinkAddOptions { /** - * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies the address (e.g., URL or file path) of the hyperlink. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Page; + address?: string; /** - * Gets the first page 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}. + * If provided, specifies the text that appears as a tooltip. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Page; + screenTip?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the location within the file or document. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; + subAddress?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the name of the frame or window in which to load the hyperlink. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.PageCollection; + target?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the visible text of the hyperlink. * - * @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.PageCollection; - /** - * 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.PageCollection; - /** - * 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.PageCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.PageCollectionData; + textToDisplay?: string; } /** - * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * Represents an inline picture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - export class Pane extends OfficeExtension.ClientObject { + export class InlinePicture 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 collection of pages in the pane. + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] */ - readonly pages: Word.PageCollection; + readonly paragraph: Word.Paragraph; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - readonly pagesEnclosingViewport: Word.PageCollection; + readonly parentContentControl: Word.ContentControl; /** - * Returns a `Selection` object that represents the current selection in the pane. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly selection: Word.Selection; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - getNext(): Word.Pane; + readonly parentTable: Word.Table; /** - * Gets the next pane. If this pane is the last one, 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}. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - getNextOrNullObject(): Word.Pane; + readonly parentTableCell: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.PaneLoadOptions): Word.Pane; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.Pane; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a string that represents the alternative text associated with the inline image. * - * @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.Pane; - /** - * 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.Pane; - /** - * 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.Pane; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.PaneData; - } - /** - * Represents the collection of pane. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export class PaneCollection 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.Pane[]; + altTextDescription: string; /** - * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getFirst(): Word.Pane; + altTextTitle: string; /** - * Gets the first pane 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}. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getFirstOrNullObject(): Word.Pane; + height: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(options?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; + hyperlink: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the format of the inline image. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.1] */ - load(propertyNames?: string | string[]): Word.PaneCollection; + readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * - * @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.PaneCollection; - /** - * 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. + * @remarks + * [Api set: WordApi 1.1] */ - track(): Word.PaneCollection; + lockAspectRatio: boolean; /** - * 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. + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.PaneCollection; + width: number; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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. */ - toJSON(): Word.Interfaces.PaneCollectionData; - } - /** - * The options that define whether to save changes before closing and whether to route the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface WindowCloseOptions { + set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.InlinePicture): void; /** - * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. + * Deletes the inline picture from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] */ - routeDocument?: boolean; + delete(): void; /** - * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. + * Gets the Base64-encoded string representation of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; - } - /** - * The options that scrolls a window or pane by the specified number of units defined by the calling method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface WindowScrollOptions { + getBase64ImageSrc(): OfficeExtension.ClientResult; /** - * If provided, specifies the number of units to scroll the window down. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. + * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - down?: number; + getNext(): Word.InlinePicture; /** - * If provided, specifies the number of screens to scroll the window to the left. - If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. + * Gets the next inline image. If this inline image is the last one, 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 + * [Api set: WordApi 1.3] */ - left?: number; + getNextOrNullObject(): Word.InlinePicture; /** - * If provided, specifies the number of screens to scroll the window to the right. - If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. + * Gets the picture, or the starting or ending point of the picture, as a range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', or 'End'. */ - right?: number; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** - * If provided, specifies the number of units to scroll the window up. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. + * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param breakType - Required. The break type to add. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - up?: number; - } - /** - * The options for scrolling through the specified pane or window page by page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface WindowPageScrollOptions { + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * If provided, specifies the number of pages to scroll the window down. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. + * Wraps the inline picture with a rich text content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - down?: number; + insertContentControl(): Word.ContentControl; /** - * If provided, specifies the number of pages to scroll the window up. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. + * Inserts a document at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * 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'. */ - up?: number; - } - /** - * Represents the window that displays the document. A window can be split to contain multiple reading panes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export class Window 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; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the active pane in the window. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] + * + * @param html - Required. The HTML to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - readonly activePane: Word.Pane; + insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the next document window in the collection of open document windows. + * Inserts an inline picture at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Before', or 'After'. */ - readonly next: Word.Window; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; /** - * Gets the collection of panes in the window. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] + * + * @param ooxml - Required. The OOXML to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - readonly panes: Word.PaneCollection; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the previous document window in the collection open document windows. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - readonly previous: Word.Window; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Gets the `View` object that represents the view for the window. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param text - Required. Text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - readonly view: Word.View; + insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Specifies whether rulers are displayed for the window or pane. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - areRulersDisplayed: boolean; + select(selectionMode?: Word.SelectionMode): void; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - readonly areScreenTipsDisplayed: boolean; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - areThumbnailsDisplayed: boolean; + load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - caption: string; + load(propertyNames?: string | string[]): Word.InlinePicture; /** - * Specifies the height of the window (in points). + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly height: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.InlinePicture; /** - * Specifies the horizontal scroll position as a percentage of the document width. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - horizontalPercentScrolled: number; + track(): Word.InlinePicture; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + untrack(): Word.InlinePicture; /** - * Gets the position of an item in a collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - readonly index: number; + toJSON(): Word.Interfaces.InlinePictureData; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class InlinePictureCollection 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.InlinePicture[]; /** - * Specifies whether the window is active. + * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isActive: boolean; + getFirst(): Word.InlinePicture; /** - * Specifies whether the document map is visible. + * Gets the first inline image 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 + * [Api set: WordApi 1.3] */ - isDocumentMapVisible: boolean; + getFirstOrNullObject(): Word.InlinePicture; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - isEnvelopeVisible: boolean; + load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - isHorizontalScrollBarDisplayed: boolean; + load(propertyNames?: string | string[]): Word.InlinePictureCollection; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isLeftScrollBarDisplayed: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - isRightRulerDisplayed: boolean; + track(): Word.InlinePictureCollection; /** - * Specifies whether the window is split into multiple panes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - isSplit: boolean; + untrack(): Word.InlinePictureCollection; /** - * Specifies whether a vertical ruler is displayed for the window or pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - isVerticalRulerDisplayed: boolean; + toJSON(): Word.Interfaces.InlinePictureCollectionData; + } + /** + * Represents the linking characteristics for an OLE object or picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class LinkFormat 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; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed: boolean; + isAutoUpdated: boolean; /** - * Specifies whether the window is visible. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + isLocked: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly left: number; + isPictureSavedWithDocument: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + sourceFullName: string; /** - * Specifies the vertical split percentage for the window. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical: number; + readonly sourceName: string; /** - * Specifies the width of the style area in points. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth: number; + readonly sourcePath: string; /** - * Specifies the vertical position of the document window, in points. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly top: number; + readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; /** - * Gets the window type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly type: Word.WindowType | "Document" | "Template"; + set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LinkFormat): void; /** - * Gets the height (in points) of the active working area in the document window. + * Breaks the link between the source file and the OLE object, picture, or linked field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly usableHeight: number; + breakLink(): void; /** - * Gets the width (in points) of the active working area in the document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly usableWidth: number; + load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - verticalPercentScrolled: number; + load(propertyNames?: string | string[]): Word.LinkFormat; /** - * Specifies the width of the document window, in points. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly width: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LinkFormat; /** - * Gets an integer that represents the position of the window. + * 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.LinkFormat; + /** + * 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.LinkFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LinkFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LinkFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LinkFormatData; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class List 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 paragraphs in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly windowNumber: number; + readonly paragraphs: Word.ParagraphCollection; /** - * Specifies the state of the document window or task window. + * Gets the list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - windowState: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + readonly id: 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. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * + * @remarks + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Window): void; + readonly levelExistences: boolean[]; /** - * Activates the window. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - activate(): void; + readonly levelTypes: Word.ListLevelType[]; /** - * Closes the window. + * Gets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] * - * @param options - The options that define whether to save changes before closing and whether to route the document. + * @param level - Required. The level in the list. */ - close(options?: Word.WindowCloseOptions): void; + getLevelFont(level: number): Word.Font; /** - * Scrolls the window by the specified number of screens. + * Gets the paragraphs that occur at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param options - The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. + * @param level - Required. The level in the list. */ - largeScroll(options?: Word.WindowScrollOptions): void; + getLevelParagraphs(level: number): Word.ParagraphCollection; /** - * Scrolls through the window page by page. + * Gets the Base64-encoded string representation of the picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] * - * @param options - The options for scrolling through the window page by page. + * @param level - Required. The level in the list. */ - pageScroll(options?: Word.WindowPageScrollOptions): void; + getLevelPicture(level: number): OfficeExtension.ClientResult; /** - * Sets the focus of the document window to the body of an email message. + * Gets the bullet, number, or picture at the specified level as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. */ - setFocus(): void; + getLevelString(level: number): OfficeExtension.ClientResult; /** - * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param options - The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Start', 'End', 'Before', or 'After'. */ - smallScroll(options?: Word.WindowScrollOptions): void; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** - * Shows or hides the ribbon. + * Resets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] + * + * @param level - Required. The level in the list. + * @param resetFontName - Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. */ - toggleRibbon(): void; + resetLevelFont(level: number, resetFontName?: boolean): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. */ - load(options?: Word.Interfaces.WindowLoadOptions): Word.Window; + setLevelAlignment(level: number, alignment: Word.Alignment): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param alignment - Required. The level alignment that must be 'Left', 'Centered', or 'Right'. */ - load(propertyNames?: string | string[]): Word.Window; + setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. * - * @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. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listBullet - Required. The bullet. + * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Window; + setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; /** - * 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. + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listBullet - Required. The bullet. + * @param charCode - Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName - Optional. The bullet's font name. Used only if the bullet is 'Custom'. */ - track(): Word.Window; + setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; /** - * 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. + * Sets the two indents of the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param textIndent - Required. The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent - Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ - untrack(): Word.Window; + setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. + * Sets the numbering format at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listNumbering - Required. The ordinal format. + * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - toJSON(): Word.Interfaces.WindowData; - } - /** - * Represents the collection of window objects. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export class WindowCollection 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.Window[]; + setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; /** - * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Sets the numbering format at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param listNumbering - Required. The ordinal format. + * @param formatString - Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - getFirst(): Word.Window; + setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; /** - * Gets the first window 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}. + * Sets the picture at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] + * + * @param level - Required. The level in the list. + * @param base64EncodedImage - Optional. The Base64-encoded image to be set. If not given, the default picture is set. */ - getFirstOrNullObject(): Word.Window; + setLevelPicture(level: number, base64EncodedImage?: string): void; + /** + * Sets the starting number at the specified level in the list. Default value is 1. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level - Required. The level in the list. + * @param startingNumber - Required. The number to start with. + */ + setLevelStartingNumber(level: number, startingNumber: number): 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.WindowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.WindowCollection; + load(options?: Word.Interfaces.ListLoadOptions): Word.List; /** * 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.WindowCollection; + load(propertyNames?: string | string[]): Word.List; /** * 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.WindowCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.List; /** * 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.WindowCollection; + track(): Word.List; /** * 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.WindowCollection; + 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.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.WindowCollectionData; + toJSON(): Word.Interfaces.ListData; } /** - * Represents a single paragraph in a selection, range, content control, or document body. + * Contains a collection of {@link Word.List} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - export class Paragraph extends OfficeExtension.ClientObject { + export class ListCollection 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.List[]; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param id - Required. A list identifier. */ - readonly borders: Word.BorderUniversalCollection; + getById(id: number): Word.List; /** - * Gets the collection of content control objects in the paragraph. + * Gets a list by its identifier. If there isn't a list 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 1.1] + * [Api set: WordApi 1.3] + * + * @param id - Required. A list identifier. */ - readonly contentControls: Word.ContentControlCollection; + getByIdOrNullObject(id: number): Word.List; /** - * Gets the collection of endnotes in the paragraph. + * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - readonly endnotes: Word.NoteItemCollection; + getFirst(): Word.List; /** - * Gets the collection of fields in the paragraph. + * Gets the first list 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 1.4] + * [Api set: WordApi 1.3] */ - readonly fields: Word.FieldCollection; + getFirstOrNullObject(): Word.List; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Gets a list object by its ID. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param id - The list's ID. */ - readonly font: Word.Font; + getItem(id: number): Word.List; /** - * Gets the collection of footnotes in the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param options - Provides options for which properties of the object to load. */ - readonly footnotes: Word.NoteItemCollection; + load(options?: Word.Interfaces.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly inlinePictures: Word.InlinePictureCollection; + load(propertyNames?: string | string[]): Word.ListCollection; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - readonly list: Word.List; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection; /** - * 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] + * 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. */ - readonly listItem: Word.ListItem; + track(): Word.ListCollection; /** - * 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] + * 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. */ - readonly listItemOrNullObject: Word.ListItem; + untrack(): Word.ListCollection; /** - * 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] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - readonly listOrNullObject: Word.List; + toJSON(): Word.Interfaces.ListCollectionData; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class ListItem 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 parent body of the paragraph. + * Specifies the level of the item in the list. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentBody: Word.Body; + level: number; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly parentContentControl: Word.ContentControl; + readonly listString: string; /** - * 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}. + * Gets the list item order number in relation to its siblings. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + readonly siblingIndex: number; /** - * 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] + * 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. */ - readonly parentTable: Word.Table; + set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListItem): void; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. * * @remarks * [Api set: WordApi 1.3] + * + * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. */ - readonly parentTableCell: Word.TableCell; + getAncestor(parentOnly?: boolean): Word.Paragraph; /** - * 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}. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, 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] + * + * @param parentOnly - Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. */ - readonly parentTableCellOrNullObject: Word.TableCell; + getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; /** - * 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}. + * Gets all descendant list items of the list item. * * @remarks * [Api set: WordApi 1.3] + * + * @param directChildrenOnly - Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. */ - readonly parentTableOrNullObject: Word.Table; + getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly shading: Word.ShadingUniversal; + load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly shapes: Word.ShapeCollection; + load(propertyNames?: string | string[]): Word.ListItem; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @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. */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListItem; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - firstLineIndent: number; + track(): Word.ListItem; /** - * Indicates the paragraph is the last one inside its parent body. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - readonly isLastParagraph: boolean; + untrack(): Word.ListItem; /** - * Checks whether the paragraph is a list item. - * - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - readonly isListItem: boolean; + toJSON(): Word.Interfaces.ListItemData; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export class ListLevel 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; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - leftIndent: number; + readonly font: Word.Font; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineSpacing: number; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineUnitAfter: number; + linkedStyle: string; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineUnitBefore: number; + numberFormat: string; /** - * Specifies the outline level for the paragraph. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel: number; + numberPosition: number; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - rightIndent: number; + numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - spaceAfter: number; + resetOnHigher: number; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - spaceBefore: number; + startAt: number; /** - * Specifies the style name for the paragraph. 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. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - style: string; + tabPosition: number; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + textPosition: number; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly tableNestingLevel: number; - /** - * Gets the text of the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - readonly text: string; - /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. - * - * @remarks - * [Api set: WordApi 1.6] - */ - readonly uniqueLocalId: string; + trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; /** * 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.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Paragraph): void; + set(properties: Word.ListLevel): void; /** - * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param listId - Required. The ID of an existing list. - * @param level - Required. The level in the list. + * @param options - Provides options for which properties of the object to load. */ - attachToList(listId: number, level: number): Word.List; + load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; /** - * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - clear(): void; + load(propertyNames?: string | string[]): Word.ListLevel; /** - * Removes any spacing before the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - closeUp(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListLevel; /** - * Deletes the paragraph and its content from the document. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - delete(): void; + track(): Word.ListLevel; /** - * Moves this paragraph out of its list, if the paragraph is a list item. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - detachFromList(): void; + untrack(): Word.ListLevel; /** - * Gets annotations set on this Paragraph object. - * - * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - getAnnotations(): Word.AnnotationCollection; + toJSON(): Word.Interfaces.ListLevelData; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export class ListLevelCollection 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.ListLevel[]; /** - * Gets comments associated with the paragraph. + * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - getComments(): Word.CommentCollection; + getFirst(): Word.ListLevel; /** - * Gets the currently supported content controls in the paragraph. + * Gets the first list level 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 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options - Optional. Options that define which content controls are returned. + * [Api set: WordApiDesktop 1.1] */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + getFirstOrNullObject(): Word.ListLevel; /** - * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param options - Provides options for which properties of the object to load. */ - getHtml(): OfficeExtension.ClientResult; + load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; /** - * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - getNext(): Word.Paragraph; + load(propertyNames?: string | string[]): Word.ListLevelCollection; /** - * Gets the next paragraph. If the paragraph is the last one, 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getNextOrNullObject(): Word.Paragraph; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection; /** - * Gets the Office Open XML (OOXML) representation of the paragraph object. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - getOoxml(): OfficeExtension.ClientResult; + track(): Word.ListLevelCollection; /** - * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - getPrevious(): Word.Paragraph; + untrack(): Word.ListLevelCollection; /** - * Gets the previous paragraph. If the paragraph is the first one, 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] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - getPreviousOrNullObject(): Word.Paragraph; + toJSON(): Word.Interfaces.ListLevelCollectionData; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export class ListTemplate 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 whole paragraph, or the starting or ending point of the paragraph, as a range. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * [Api set: WordApiDesktop 1.1] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + readonly listLevels: Word.ListLevelCollection; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + name: string; /** - * Gets reviewed text based on ChangeTrackingVersion selection. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * [Api set: WordApiDesktop 1.1] */ - getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + outlineNumbered: boolean; /** - * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). - By default, hidden text and text marked as deleted are excluded. - * - * @remarks - * [Api set: WordApi 1.7] - * - * @param options - Optional. Options that define whether the final result should include hidden text and text marked as deleted. + * 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. */ - getText(options?: Word.GetTextOptions | { - IncludeHiddenText?: boolean; - IncludeTextMarkedAsDeleted?: boolean; - }): OfficeExtension.ClientResult; + set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListTemplate): void; /** - * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @param options - Provides options for which properties of the object to load. */ - getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate; /** - * Gets the collection of the TrackedChange objects in the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.6] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - getTrackedChanges(): Word.TrackedChangeCollection; + load(propertyNames?: string | string[]): Word.ListTemplate; /** - * Indents the paragraph by one level. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - indent(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListTemplate; /** - * Indents the paragraph by a specified number of characters. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param count - The number of characters for the indent. + * 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. */ - indentCharacterWidth(count: number): void; + track(): Word.ListTemplate; /** - * Indents the first line of the paragraph by the specified number of characters. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param count - The number of characters for the first line indent. + * 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. */ - indentFirstLineCharacterWidth(count: number): void; + untrack(): Word.ListTemplate; /** - * Inserts annotations on this Paragraph object. - * - * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. - * - * @param annotations - Annotations to set. - * @returns An array of the inserted annotations identifiers. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; + toJSON(): Word.Interfaces.ListTemplateData; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class NoteItem 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; /** - * Inserts a break at the specified location in the main document. + * 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.1] - * - * @param breakType - Required. The break type to add to the document. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.5] */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + readonly body: Word.Body; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param insertShapeOptions - Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). + * [Api set: WordApi 1.5] */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + readonly reference: Word.Range; /** - * Wraps the Paragraph object with a content control. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. - * - * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * [Api set: WordApi 1.5] */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + readonly type: Word.NoteItemType | "Footnote" | "Endnote"; /** - * Inserts a document into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * 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'. + * 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. */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.NoteItem): void; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. + * Deletes the note item. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType - The geometric type of the shape to insert. - * @param insertShapeOptions - Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * [Api set: WordApi 1.5] */ - insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + delete(): void; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. + * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType - The geometric type of the shape to insert. - * @param insertShapeOptions - Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * [Api set: WordApi 1.5] */ - insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + getNext(): Word.NoteItem; /** - * Inserts HTML into the paragraph at the specified location. + * Gets the next note item of the same type. If this note item is the last one, 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.1] - * - * @param html - Required. The HTML to be inserted in the paragraph. - * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + * [Api set: WordApi 1.5] */ - insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + getNextOrNullObject(): Word.NoteItem; /** - * Inserts a picture into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + * @param options - Provides options for which properties of the object to load. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem; /** - * Inserts OOXML into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param ooxml - Required. The OOXML to be inserted in the paragraph. - * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + load(propertyNames?: string | string[]): Word.NoteItem; /** - * Inserts a paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param paragraphText - Required. The paragraph text to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @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. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.NoteItem; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions - Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * 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. */ - insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + track(): Word.NoteItem; /** - * Inserts a table with the specified number of rows and columns. + * 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.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. + */ + toJSON(): Word.Interfaces.NoteItemData; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export class NoteItemCollection 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.NoteItem[]; + /** + * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rowCount - Required. The number of rows in the table. - * @param columnCount - Required. The number of columns in the table. - * @param insertLocation - Required. The value must be 'Before' or 'After'. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * [Api set: WordApi 1.5] */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + getFirst(): Word.NoteItem; /** - * Inserts text into the paragraph at the specified location. + * Gets the first note item 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 1.1] + * [Api set: WordApi 1.5] + */ + getFirstOrNullObject(): Word.NoteItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param text - Required. Text to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. + * @param options - Provides options for which properties of the object to load. */ - insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; /** - * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.NoteItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param text - Optional. The text to insert into the text box. - * @param insertShapeOptions - Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). + * @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. */ - insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection; /** - * Joins a list paragraph with the closest list above or below this paragraph. + * 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.NoteItemCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.NoteItemCollectionData; + } + /** + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class OleFormat 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; + /** + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - joinList(): void; + classType: string; /** - * Returns a `Paragraph` object that represents the next paragraph. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count - Optional. The number of paragraphs to move forward. */ - next(count: number): Word.Paragraph; + iconIndex: number; /** - * Toggles the spacing before the paragraph. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openOrCloseUp(): void; + iconLabel: string; /** - * Sets spacing before the paragraph to 12 points. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openUp(): void; + iconName: string; /** - * Removes one level of indent for the paragraph. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outdent(): void; + readonly iconPath: string; /** - * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemote(): void; + readonly isDisplayedAsIcon: boolean; /** - * Demotes the paragraph to body text by applying the Normal style. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemoteToBody(): void; + isFormattingPreservedOnUpdate: boolean; /** - * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinePromote(): void; + readonly label: string; /** - * Returns the previous paragraph as a `Paragraph` object. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count - Optional. The number of paragraphs to move backward. */ - previous(count: number): Word.Paragraph; + readonly progId: string; /** - * Removes manual paragraph formatting (formatting not applied using a style). + * 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.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.OleFormat): void; + /** + * Activates the `OleFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reset(): void; + activate(): void; /** - * Resets the paragraph that uses custom list levels to the original level settings. + * Sets the Windows registry value that determines the default application used to activate the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - resetAdvanceTo(): void; - /** - * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. - * - * @remarks - * [Api set: WordApi 1.1] * - * @param searchText - Required. The search text. - * @param searchOptions - Optional. Options for the search. + * @param classType - The class type to activate as. */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + activateAs(classType: string): void; /** - * Selects and navigates the Word UI to the paragraph. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param verbIndex - Optional. The index of the verb to perform. */ - select(selectionMode?: Word.SelectionMode): void; + doVerb(verbIndex: Word.OleVerb): void; /** - * Selects and navigates the Word UI to the paragraph. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param verbIndex - Optional. The index of the verb to perform. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; /** - * Selects the number or bullet in a list. + * Opens the OLE object for editing in the application it was created in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectNumber(): void; + edit(): void; /** - * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. + * Opens the `OleFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateList(): void; + open(): void; /** - * Sets the paragraph to single spacing. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - space1(): void; + load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat; /** - * Sets the paragraph to 1.5-line spacing. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - space1Pt5(): void; + load(propertyNames?: string | string[]): Word.OleFormat; /** - * Sets the paragraph to double spacing. + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.OleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.OleFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.OleFormatData; + } + /** + * Represents a page in the document. `Page` objects manage the page layout and content. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class Page 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 a `BreakCollection` object that represents the breaks on the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space2(): void; + readonly breaks: Word.BreakCollection; /** - * Splits the paragraph into child ranges by using delimiters. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + */ + readonly height: number; + /** + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * - * @param delimiters - Required. The delimiters as an array of strings. - * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + readonly index: number; /** - * Starts a new list with this paragraph. Fails if the paragraph is already a list item. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - startNewList(): Word.List; + readonly width: number; /** - * Sets a hanging indent to a specified number of tab stops. + * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + */ + getNext(): Word.Page; + /** + * Gets the next page. If this page is the last one, 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}. * - * @param count - The number of tab stops for the hanging indent. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - tabHangingIndent(count: number): void; + getNextOrNullObject(): Word.Page; /** - * Sets the left indent for the paragraph to a specified number of tab stops. + * Gets the whole page, or the starting or ending point of the page, as a range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param count - The number of tab stops for the left indent. + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', or 'End'. */ - tabIndent(count: number): void; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** * 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.ParagraphLoadOptions): Word.Paragraph; + load(options?: Word.Interfaces.PageLoadOptions): Word.Page; /** * 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.Paragraph; + load(propertyNames?: string | string[]): Word.Page; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -12038,423 +12154,683 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Paragraph; + }): Word.Page; /** - * Occurs when new comments are added. + * 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.Page; + /** + * 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.Page; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PageData; + } + /** + * Represents the collection of page. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class PageCollection 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.Page[]; + /** + * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * - * @eventproperty - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentAdded: OfficeExtension.EventHandlers; + getFirst(): Word.Page; /** - * Occurs when a comment or its reply is changed. + * Gets the first page 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)] + * [Api set: WordApiDesktop 1.2] + */ + getFirstOrNullObject(): Word.Page; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @eventproperty - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly onCommentChanged: OfficeExtension.EventHandlers; + load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; /** - * Occurs when comments are deleted. + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.PageCollectionData; + } + /** + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class Pane 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 collection of pages in the pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.2] + */ + readonly pages: Word.PageCollection; + /** + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. * - * @eventproperty - * @beta + * @remarks + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentDeleted: OfficeExtension.EventHandlers; + readonly pagesEnclosingViewport: Word.PageCollection; /** - * Occurs when a comment is deselected. + * Returns a `Selection` object that represents the current selection in the pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * - * @eventproperty * @beta */ - readonly onCommentDeselected: OfficeExtension.EventHandlers; + readonly selection: Word.Selection; /** - * Occurs when a comment is selected. + * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.2] + */ + getNext(): Word.Pane; + /** + * Gets the next pane. If this pane is the last one, 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}. * - * @eventproperty - * @beta + * @remarks + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentSelected: OfficeExtension.EventHandlers; + getNextOrNullObject(): Word.Pane; + /** + * 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.PaneLoadOptions): Word.Pane; + /** + * 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.Pane; + /** + * 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.Pane; /** * 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.Paragraph; + track(): Word.Pane; /** * 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.Paragraph; + untrack(): Word.Pane; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphData; + toJSON(): Word.Interfaces.PaneData; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents the collection of pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - export class ParagraphCollection extends OfficeExtension.ClientObject { + export class PaneCollection 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.Paragraph[]; + readonly items: Word.Pane[]; /** - * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. + * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param range - The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. + * [Api set: WordApiDesktop 1.2] */ - add(range: Word.Range): Word.Paragraph; + getFirst(): Word.Pane; /** - * Removes any spacing before the specified paragraphs. + * Gets the first pane 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 + * [Api set: WordApiDesktop 1.2] */ - closeUp(): void; + getFirstOrNullObject(): Word.Pane; /** - * Decreases the spacing before and after paragraphs in six-point increments. + * 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.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; + /** + * 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.PaneCollection; + /** + * 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.PaneCollection; + /** + * 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.PaneCollection; + /** + * 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.PaneCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.PaneCollectionData; + } + /** + * The options that define whether to save changes before closing and whether to route the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface WindowCloseOptions { + /** + * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decreaseSpacing(): void; + routeDocument?: boolean; /** - * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Paragraph; + saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; + } + /** + * The options that scrolls a window or pane by the specified number of units defined by the calling method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface WindowScrollOptions { /** - * Gets the first paragraph in this collection. If the 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}. + * If provided, specifies the number of units to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Paragraph; + down?: number; /** - * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * If provided, specifies the number of screens to scroll the window to the left. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLast(): Word.Paragraph; + left?: number; /** - * Gets the last paragraph in this collection. If the 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}. + * If provided, specifies the number of screens to scroll the window to the right. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLastOrNullObject(): Word.Paragraph; + right?: number; /** - * Increases the spacing before and after paragraphs in six-point increments. + * If provided, specifies the number of units to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - increaseSpacing(): void; + up?: number; + } + /** + * The options for scrolling through the specified pane or window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface WindowPageScrollOptions { /** - * Indents the paragraphs by one level. + * If provided, specifies the number of pages to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent(): void; + down?: number; /** - * Indents the paragraphs in the collection by the specified number of characters. + * If provided, specifies the number of pages to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + up?: number; + } + /** + * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class Window 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 active pane in the window. * - * @param count - The number of characters by which the specified paragraphs are to be indented. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - indentCharacterWidth(count: number): void; + readonly activePane: Word.Pane; /** - * Indents the first line of the paragraphs in the collection by the specified number of characters. + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + readonly next: Word.Window; + /** + * Gets the collection of panes in the window. * - * @param count - The number of characters by which the first line of each specified paragraph is to be indented. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - indentFirstLineCharacterWidth(count: number): void; + readonly panes: Word.PaneCollection; /** - * Toggles spacing before paragraphs. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openOrCloseUp(): void; + readonly previous: Word.Window; /** - * Sets spacing before the specified paragraphs to 12 points. + * Gets the `View` object that represents the view for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openUp(): void; + readonly view: Word.View; /** - * Removes one level of indent for the paragraphs. + * Specifies whether rulers are displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outdent(): void; + areRulersDisplayed: boolean; /** - * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemote(): void; + readonly areScreenTipsDisplayed: boolean; /** - * Demotes the specified paragraphs to body text by applying the Normal style. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemoteToBody(): void; + areThumbnailsDisplayed: boolean; /** - * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinePromote(): void; + caption: string; /** - * Sets the specified paragraphs to single spacing. + * Specifies the height of the window (in points). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space1(): void; + readonly height: number; /** - * Sets the specified paragraphs to 1.5-line spacing. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space1Pt5(): void; + horizontalPercentScrolled: number; /** - * Sets the specified paragraphs to double spacing. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space2(): void; + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Sets a hanging indent to the specified number of tab stops. + * Gets the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count - The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - tabHangingIndent(count: number): void; + readonly index: number; /** - * Sets the left indent for the specified paragraphs to the specified number of tab stops. + * Specifies whether the window is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count - The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - tabIndent(count: number): void; + readonly isActive: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the document map is visible. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; + isDocumentMapVisible: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ParagraphCollection; + isEnvelopeVisible: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether a horizontal scroll bar is displayed for the window. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; + isHorizontalScrollBarDisplayed: boolean; /** - * 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. + * Specifies whether the vertical scroll bar appears on the left side of the document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ParagraphCollection; + isLeftScrollBarDisplayed: boolean; /** - * 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. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ParagraphCollection; + isRightRulerDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ParagraphCollectionData; - } - /** - * Represents a style of paragraph in a document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export class ParagraphFormat 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; + isSplit: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isVerticalRulerDisplayed: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent: number; + isVerticalScrollBarDisplayed: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether: boolean; + isVisible: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext: boolean; + readonly left: number; /** - * Specifies the left indent. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent: number; + showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing: number; + splitVertical: number; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter: number; + styleAreaWidth: number; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore: number; + readonly top: number; /** - * Specifies whether left and right indents are the same width. + * Gets the window type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents: boolean; + readonly type: Word.WindowType | "Document" | "Template"; /** - * Specifies the outline level for the specified paragraphs. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + readonly usableHeight: number; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent: number; + readonly usableWidth: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter: number; + verticalPercentScrolled: number; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore: number; + readonly width: number; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl: boolean; + readonly windowNumber: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState: Word.WindowState | "Normal" | "Maximize" | "Minimize"; /** * 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.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ParagraphFormat): void; + set(properties: Word.Window): void; + /** + * Activates the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + activate(): void; + /** + * Closes the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - The options that define whether to save changes before closing and whether to route the document. + */ + close(options?: Word.WindowCloseOptions): void; + /** + * Scrolls the window by the specified number of screens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. + */ + largeScroll(options?: Word.WindowScrollOptions): void; + /** + * Scrolls through the window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - The options for scrolling through the window page by page. + */ + pageScroll(options?: Word.WindowPageScrollOptions): void; + /** + * Sets the focus of the document window to the body of an email message. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setFocus(): void; + /** + * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. + */ + smallScroll(options?: Word.WindowScrollOptions): void; + /** + * Shows or hides the ribbon. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleRibbon(): 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.ParagraphFormatLoadOptions): Word.ParagraphFormat; + load(options?: Word.Interfaces.WindowLoadOptions): Word.Window; /** * 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.ParagraphFormat; + load(propertyNames?: string | string[]): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -12463,603 +12839,418 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ParagraphFormat; + }): Word.Window; /** * 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.ParagraphFormat; + track(): Word.Window; /** * 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.ParagraphFormat; + untrack(): Word.Window; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphFormatData; + toJSON(): Word.Interfaces.WindowData; } /** - * Represents a contiguous area in a document. + * Represents the collection of window objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - export class Range extends OfficeExtension.ClientObject { + export class WindowCollection 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.Window[]; /** - * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. + * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly bookmarks: Word.BookmarkCollection; + getFirst(): Word.Window; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Gets the first window 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 + * [Api set: WordApiDesktop 1.2] */ - readonly borders: Word.BorderUniversalCollection; + getFirstOrNullObject(): Word.Window; /** - * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly conflicts: Word.ConflictCollection; + load(options?: Word.Interfaces.WindowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.WindowCollection; /** - * Gets the collection of content control objects in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly contentControls: Word.ContentControlCollection; + load(propertyNames?: string | string[]): Word.WindowCollection; /** - * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. + * 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.WindowCollection; + /** + * 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.WindowCollection; + /** + * 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.WindowCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.WindowCollectionData; + } + /** + * Represents a single paragraph in a selection, range, content control, or document body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Paragraph 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly editors: Word.EditorCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the collection of endnotes in the range. + * Gets the collection of content control objects in the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the range. + * Gets the collection of fields in the paragraph. * * @remarks * [Api set: WordApi 1.4] */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * 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] */ readonly font: Word.Font; /** - * Gets the collection of footnotes in the range. + * Gets the collection of footnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly footnotes: Word.NoteItemCollection; /** - * Gets a `FrameCollection` object that represents all the frames in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly frames: Word.FrameCollection; - /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly hyperlinks: Word.HyperlinkCollection; - /** - * Gets the collection of inline picture objects in the range. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly listFormat: Word.ListFormat; + readonly list: Word.List; /** - * Gets the collection of list objects in the range. + * 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] */ - readonly lists: Word.ListCollection; + readonly listItem: Word.ListItem; /** - * Gets the collection of pages in the range. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly pages: Word.PageCollection; + readonly listItemOrNullObject: Word.ListItem; /** - * Gets the collection of paragraph objects in the range. + * 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.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * [Api set: WordApi 1.3] */ - readonly paragraphs: Word.ParagraphCollection; + readonly listOrNullObject: Word.List; /** - * Gets the parent body of the range. + * Gets the parent body of the paragraph. * * @remarks * [Api set: WordApi 1.3] */ readonly parentBody: Word.Body; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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] */ readonly parentContentControl: Word.ContentControl; /** - * 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}. + * 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] */ readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * 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] */ readonly parentTable: Word.Table; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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] */ readonly parentTableCell: Word.TableCell; /** - * 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}. + * 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] */ readonly parentTableCellOrNullObject: Word.TableCell; /** - * 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}. + * 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] */ readonly parentTableOrNullObject: Word.Table; /** - * Gets the collection of revisions that represents the tracked changes in the range. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly revisions: Word.RevisionCollection; + readonly shading: Word.ShadingUniversal; /** - * Gets the collection of sections in the range. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly sections: Word.SectionCollection; + readonly shapes: Word.ShapeCollection; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly shading: Word.ShadingUniversal; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - readonly shapes: Word.ShapeCollection; + firstLineIndent: number; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly tableColumns: Word.TableColumnCollection; + readonly isLastParagraph: boolean; /** - * Gets the collection of table objects in the range. + * Checks whether the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] */ - readonly tables: Word.TableCollection; + readonly isListItem: boolean; /** - * Specifies whether the range is formatted as bold. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly bold: boolean; + leftIndent: number; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly boldBidirectional: boolean; + lineSpacing: number; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + lineUnitAfter: number; /** - * Specifies the character width of the range. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - characterWidth: Word.CharacterWidth | "Half" | "Full"; + lineUnitBefore: number; /** - * Specifies if the range contains combined characters. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - combineCharacters: boolean; + outlineLevel: number; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly disableCharacterSpaceGrid: boolean; + rightIndent: number; /** - * Specifies the emphasis mark for a character or designated character string. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + spaceAfter: number; /** - * Specifies the ending character position of the range. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - end: number; + spaceBefore: number; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the style name for the paragraph. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - fitTextWidth: number; + style: string; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - grammarChecked: boolean; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hasNoProofing: boolean; + readonly tableNestingLevel: number; /** - * Specifies the highlight color for the range. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + readonly text: string; /** - * Specifies the formatting for horizontal text set within vertical text. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; - /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ - hyperlink: string; - /** - * Specifies the ID for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - id: string; - /** - * Checks whether the range length is zero. - * - * @remarks - * [Api set: WordApi 1.3] - */ - readonly isEmpty: boolean; - /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isEndOfRowMark: boolean; - /** - * Gets whether the text in the range is visible on the screen. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isTextVisibleOnScreen: boolean; - /** - * Specifies if the font or range is formatted as italic. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly italic: boolean; - /** - * Specifies if the font or range is formatted as italic (right-to-left languages). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly italicBidirectional: boolean; - /** - * Specifies whether the range of Japanese language text is hiragana or katakana. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kana: Word.Kana | "Katakana" | "Hiragana"; - /** - * Specifies whether Microsoft Word has detected the language of the text in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageDetected: boolean; - /** - * Specifies a `LanguageId` value that represents the language for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies an East Asian language for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies a language for the range that isn't classified as an East Asian language. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - showAll: boolean; - /** - * Specifies if spelling has been checked throughout the range or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spellingChecked: boolean; - /** - * Specifies the starting character position of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - start: number; - /** - * Gets the number of characters in the story that contains the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly storyLength: number; - /** - * Gets the story type for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - /** - * Specifies the style name for the range. 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. - * - * @remarks - * [Api set: WordApi 1.1] - */ - style: string; - /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - /** - * Gets the text of the range. - * - * @remarks - * [Api set: WordApi 1.1] - */ - readonly text: string; - /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; - /** - * Specifies the type of underline applied to the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly underline: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + readonly uniqueLocalId: string; /** * 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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Range): void; - /** - * Clears the contents of the range object. The user can perform the undo operation on the cleared content. - * - * @remarks - * [Api set: WordApi 1.1] - */ - clear(): void; + set(properties: Word.Paragraph): void; /** - * Compares this range's location with another range's location. + * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. * * @remarks * [Api set: WordApi 1.3] * - * @param range - Required. The range to compare with this range. + * @param listId - Required. The ID of an existing list. + * @param level - Required. The level in the list. */ - compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; + attachToList(listId: number, level: number): Word.List; /** - * Deletes the range and its content from the document. + * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] */ - delete(): void; + clear(): void; /** - * Analyzes the range text to determine the language that it's written in. + * Removes any spacing before the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): OfficeExtension.ClientResult; + closeUp(): 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 don't have a union. + * Deletes the paragraph and its content from the document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param range - Required. Another range. + * [Api set: WordApi 1.1] */ - expandTo(range: Word.Range): Word.Range; + delete(): void; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, 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}. + * Moves this paragraph out of its list, if the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] - * - * @param range - Required. Another range. */ - expandToOrNullObject(range: Word.Range): Word.Range; + detachFromList(): void; /** - * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. + * Gets annotations set on this Paragraph object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] * - * @param includeHidden - Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. - * @param includeAdjacent - Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. */ - getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; + getAnnotations(): Word.AnnotationCollection; /** - * Gets comments associated with the range. + * Gets comments associated with the paragraph. * * @remarks * [Api set: WordApi 1.4] - * @returns */ getComments(): Word.CommentCollection; /** - * Gets the currently supported content controls in the range. + * Gets the currently supported content controls in the paragraph. * * @remarks * [Api set: WordApi 1.5] * - * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. * @@ -13067,48 +13258,49 @@ export declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets hyperlink child ranges within the range. + * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. * * @remarks * [Api set: WordApi 1.3] */ - getHyperlinkRanges(): Word.RangeCollection; + getNext(): Word.Paragraph; /** - * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. + * Gets the next paragraph. If the paragraph is the last one, 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] + */ + getNextOrNullObject(): Word.Paragraph; + /** + * Gets the Office Open XML (OOXML) representation of the paragraph object. * - * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @remarks + * [Api set: WordApi 1.1] */ - getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; + getOoxml(): OfficeExtension.ClientResult; /** - * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, 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}. + * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. * * @remarks * [Api set: WordApi 1.3] - * - * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; + getPrevious(): Word.Paragraph; /** - * Gets the OOXML representation of the range object. + * Gets the previous paragraph. If the paragraph is the first one, 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.1] + * [Api set: WordApi 1.3] */ - getOoxml(): OfficeExtension.ClientResult; + getPreviousOrNullObject(): Word.Paragraph; /** - * Clones the range, or gets the starting or ending point of the range as a new range. + * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. * * @remarks * [Api set: WordApi 1.3] @@ -13135,7 +13327,20 @@ export declare namespace Word { */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. + * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). + By default, hidden text and text marked as deleted are excluded. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param options - Optional. Options that define whether the final result should include hidden text and text marked as deleted. + */ + getText(options?: Word.GetTextOptions | { + IncludeHiddenText?: boolean; + IncludeTextMarkedAsDeleted?: boolean; + }): OfficeExtension.ClientResult; + /** + * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. * * @remarks * [Api set: WordApi 1.3] @@ -13145,113 +13350,85 @@ export declare namespace Word { */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the range. + * Gets the collection of the TrackedChange objects in the paragraph. * * @remarks * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; /** - * Highlights the range temporarily without changing document content. - To highlight the text permanently, set the range's Font.HighlightColor. + * Indents the paragraph by one level. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlight(): void; + indent(): void; /** - * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. + * Indents the paragraph by a specified number of characters. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param count - The number of characters for the indent. */ - insertBookmark(name: string): void; + indentCharacterWidth(count: number): void; /** - * Inserts a break at the specified location in the main document. + * Indents the first line of the paragraph by the specified number of characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param breakType - Required. The break type to add. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param count - The number of characters for the first line indent. */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + indentFirstLineCharacterWidth(count: number): void; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the range. + * Inserts annotations on this Paragraph object. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param insertShapeOptions - Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). - */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Insert a comment on the range. + * [Api set: WordApi 1.7] * - * @remarks - * [Api set: WordApi 1.4] + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. * - * @param commentText - Required. The comment text to be inserted. - * @returns comment object + * @param annotations - Annotations to set. + * @returns An array of the inserted annotations identifiers. */ - insertComment(commentText: string): Word.Comment; + insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; /** - * Wraps the Range object with a content control. + * Inserts a break at the specified location in the main document. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. - * - * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. - */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; - /** - * Inserts an endnote. The endnote reference is placed after the range. - * - * @remarks - * [Api set: WordApi 1.5] - * - * @param insertText - Optional. Text to be inserted into the endnote body. The default is "". + * @param breakType - Required. The break type to add to the document. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - insertEndnote(insertText?: string): Word.NoteItem; + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * Inserts a field at the specified location. + * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * [Api set: WordApiDesktop 1.2] * - * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. - * @param text - Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * @param insertShapeOptions - Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts a field at the specified location. + * Wraps the Paragraph object with a content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. * - * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. - * @param text - Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; /** - * Inserts a document at the specified location. + * Inserts a document into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] @@ -13259,20 +13436,11 @@ export declare namespace Word { * 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'. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; - /** - * Inserts a footnote. The footnote reference is placed after the range. - * - * @remarks - * [Api set: WordApi 1.5] - * - * @param insertText - Optional. Text to be inserted into the footnote body. The default is "". + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ - insertFootnote(insertText?: string): Word.NoteItem; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -13282,7 +13450,7 @@ export declare namespace Word { */ insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -13292,35 +13460,35 @@ export declare namespace Word { */ insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts HTML at the specified location. + * Inserts HTML into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * - * @param html - Required. The HTML to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param html - Required. The HTML to be inserted in the paragraph. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ - insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a picture at the specified location. + * Inserts a picture into the paragraph at the specified location. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.1] * * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** - * Inserts OOXML at the specified location. + * Inserts OOXML into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * - * @param ooxml - Required. The OOXML to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param ooxml - Required. The OOXML to be inserted in the paragraph. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** * Inserts a paragraph at the specified location. * @@ -13332,13 +13500,13 @@ export declare namespace Word { */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the range. + * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] * * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions - Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * @param insertShapeOptions - Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** @@ -13354,17 +13522,17 @@ export declare namespace Word { */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Inserts text at the specified location. + * Inserts text into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * * @param text - Required. Text to be inserted. - * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param insertLocation - Required. The value must be 'Replace', 'Start', or 'End'. */ - insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a floating text box in front of text with its anchor at the beginning of the range. + * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -13374,91 +13542,224 @@ export declare namespace Word { */ 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. + * Joins a list paragraph with the closest list above or below this paragraph. * * @remarks - * [Api set: WordApi 1.3] - * - * @param range - Required. Another range. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - intersectWith(range: Word.Range): Word.Range; + joinList(): void; /** - * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, 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}. + * Returns a `Paragraph` object that represents the next paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param range - Required. Another range. + * @param count - Optional. The number of paragraphs to move forward. */ - intersectWithOrNullObject(range: Word.Range): Word.Range; + next(count: number): Word.Paragraph; /** - * Removes the highlight added by the Highlight function if any. + * Toggles the spacing before the paragraph. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeHighlight(): void; + openOrCloseUp(): void; /** - * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. + * Sets spacing before the paragraph to 12 points. * * @remarks - * [Api set: WordApi 1.1] - * - * @param searchText - Required. The search text. - * @param searchOptions - Optional. Options for the search. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + openUp(): void; /** - * Selects and navigates the Word UI to the range. + * Removes one level of indent for the paragraph. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: Word.SelectionMode): void; + outdent(): void; /** - * Selects and navigates the Word UI to the range. + * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: "Select" | "Start" | "End"): void; + outlineDemote(): void; /** - * Splits the range into child ranges by using delimiters. + * Demotes the paragraph to body text by applying the Normal style. * * @remarks - * [Api set: WordApi 1.3] - * - * @param delimiters - Required. The delimiters as an array of strings. - * @param multiParagraphs - Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. - * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + outlineDemoteToBody(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RangeLoadOptions): Word.Range; + outlinePromote(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the previous paragraph as a `Paragraph` object. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.Range; - /** + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - Optional. The number of paragraphs to move backward. + */ + previous(count: number): Word.Paragraph; + /** + * Removes manual paragraph formatting (formatting not applied using a style). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reset(): void; + /** + * Resets the paragraph that uses custom list levels to the original level settings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resetAdvanceTo(): void; + /** + * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Selects the number or bullet in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectNumber(): void; + /** + * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateList(): void; + /** + * Sets the paragraph to single spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1(): void; + /** + * Sets the paragraph to 1.5-line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1Pt5(): void; + /** + * Sets the paragraph to double spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space2(): void; + /** + * Splits the paragraph into child ranges by using delimiters. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param delimiters - Required. The delimiters as an array of strings. + * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + */ + split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + /** + * Starts a new list with this paragraph. Fails if the paragraph is already a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + startNewList(): Word.List; + /** + * Sets a hanging indent to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of tab stops for the hanging indent. + */ + tabHangingIndent(count: number): void; + /** + * Sets the left indent for the paragraph to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of tab stops for the left indent. + */ + tabIndent(count: number): 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.ParagraphLoadOptions): Word.Paragraph; + /** + * 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.Paragraph; + /** * 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. @@ -13466,7 +13767,7 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Range; + }): Word.Paragraph; /** * Occurs when new comments are added. * @@ -13487,6 +13788,16 @@ export declare namespace Word { * @beta */ readonly onCommentChanged: OfficeExtension.EventHandlers; + /** + * Occurs when comments are deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * + * @eventproperty + * @beta + */ + readonly onCommentDeleted: OfficeExtension.EventHandlers; /** * Occurs when a comment is deselected. * @@ -13510,462 +13821,369 @@ export declare namespace Word { /** * 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.Range; + track(): Word.Paragraph; /** * 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.Range; + 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.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. + * 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.RangeData; + toJSON(): Word.Interfaces.ParagraphData; } /** - * Contains a collection of {@link Word.Range} objects. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks * [Api set: WordApi 1.1] */ - export class RangeCollection extends OfficeExtension.ClientObject { + export class ParagraphCollection 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.Range[]; - /** - * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.Range; + readonly items: Word.Paragraph[]; /** - * Gets the first range 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}. + * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. * * @remarks - * [Api set: WordApi 1.3] - */ - getFirstOrNullObject(): Word.Range; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param options - Provides options for which properties of the object to load. + * @param range - The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. */ - load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; + add(range: Word.Range): Word.Paragraph; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Removes any spacing before the specified paragraphs. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RangeCollection; + closeUp(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Decreases the spacing before and after paragraphs in six-point increments. * - * @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.RangeCollection; - /** - * 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.RangeCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RangeCollectionData; - } - /** - * Specifies the options to determine location and size when inserting a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export interface InsertShapeOptions { + decreaseSpacing(): void; /** - * Represents the height of the shape being inserted. + * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height?: number; + getFirst(): Word.Paragraph; /** - * Represents the left position of the shape being inserted. + * Gets the first paragraph in this collection. If the 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - left?: number; + getFirstOrNullObject(): Word.Paragraph; /** - * Represents the top position of the shape being inserted. + * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - top?: number; + getLast(): Word.Paragraph; /** - * Represents the width of the shape being inserted. + * Gets the last paragraph in this collection. If the 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - width?: number; - } - /** - * Specifies the options to determine what to copy when inserting a file. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface InsertFileOptions { + getLastOrNullObject(): Word.Paragraph; /** - * Represents whether the change tracking mode status from the source document should be imported. + * Increases the spacing before and after paragraphs in six-point increments. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importChangeTrackingMode?: boolean; + increaseSpacing(): void; /** - * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * Indents the paragraphs by one level. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importCustomProperties?: boolean; + indent(): void; /** - * Represents whether the custom XML parts from the source document should be imported. + * Indents the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of characters by which the specified paragraphs are to be indented. */ - importCustomXmlParts?: boolean; + indentCharacterWidth(count: number): void; /** - * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * Indents the first line of the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of characters by which the first line of each specified paragraph is to be indented. */ - importDifferentOddEvenPages?: boolean; + indentFirstLineCharacterWidth(count: number): void; /** - * Represents whether the page color and other background information from the source document should be imported. + * Toggles spacing before paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importPageColor?: boolean; + openOrCloseUp(): void; /** - * Represents whether the paragraph spacing from the source document should be imported. + * Sets spacing before the specified paragraphs to 12 points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importParagraphSpacing?: boolean; + openUp(): void; /** - * Represents whether the styles from the source document should be imported. + * Removes one level of indent for the paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStyles?: boolean; + outdent(): void; /** - * Represents whether the theme from the source document should be imported. + * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importTheme?: boolean; - } - /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export class SearchOptions 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; + outlineDemote(): void; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Demotes the specified paragraphs to body text by applying the Normal style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct: boolean; + outlineDemoteToBody(): void; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace: boolean; + outlinePromote(): void; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Sets the specified paragraphs to single spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase: boolean; + space1(): void; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Sets the specified paragraphs to 1.5-line spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix: boolean; + space1Pt5(): void; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Sets the specified paragraphs to double spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix: boolean; + space2(): void; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Sets a hanging indent to the specified number of tab stops. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - matchWholeWord: boolean; + tabHangingIndent(count: number): void; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Sets the left indent for the specified paragraphs to the specified number of tab stops. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards: boolean; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count - The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - set(properties: Interfaces.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.SearchOptions): void; + tabIndent(count: number): 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.SearchOptionsLoadOptions): Word.SearchOptions; + load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; /** * 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.SearchOptions; + load(propertyNames?: string | string[]): Word.ParagraphCollection; /** * 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.SearchOptions; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; /** - * Create a new instance of the `Word.SearchOptions` object. + * 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. */ - static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; + track(): Word.ParagraphCollection; + /** + * 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.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.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. + * 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.SearchOptionsData; + toJSON(): Word.Interfaces.ParagraphCollectionData; } /** - * Specifies the options to be included in a getText operation. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - export interface GetTextOptions { + export class ParagraphFormat 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; /** - * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - includeHiddenText?: boolean; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - includeTextMarkedAsDeleted?: boolean; - } - /** - * Specifies the options to be included in a compare document operation. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export interface DocumentCompareOptions { + firstLineIndent: number; /** - * True adds the document to the list of recently used files on the File menu. The default value is True. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - addToRecentFiles?: boolean; + keepTogether: boolean; /** - * The reviewer name associated with the differences generated by the comparison. - If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - authorName?: string; + keepWithNext: boolean; /** - * The target document for the comparison. Default value is 'CompareTargetCurrent'. + * Specifies the left indent. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; + leftIndent: number; /** - * True (default) for the comparison to include detection of format changes. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - detectFormatChanges?: boolean; + lineSpacing: number; /** - * True compares the documents without notifying a user of problems. The default value is False. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - ignoreAllComparisonWarnings?: boolean; + lineUnitAfter: number; /** - * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - removeDateAndTime?: boolean; + lineUnitBefore: number; /** - * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - removePersonalInformation?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export class Section 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; + mirrorIndents: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - readonly body: Word.Body; + outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly borders: Word.BorderUniversalCollection; + rightIndent: number; /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly pageSetup: Word.PageSetup; - /** - * Specifies if the section is protected for forms. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - protectedForForms: boolean; - /** - * 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.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Section): void; - /** - * Gets one of the section's footers. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. - */ - getFooter(type: Word.HeaderFooterType): Word.Body; - /** - * Gets one of the section's footers. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. - */ - getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; - /** - * Gets one of the section's headers. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * [Api set: WordApi 1.5] */ - getHeader(type: Word.HeaderFooterType): Word.Body; + spaceAfter: number; /** - * Gets one of the section's headers. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * [Api set: WordApi 1.5] */ - getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + spaceBefore: number; /** - * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getNext(): Word.Section; + widowControl: boolean; /** - * Gets the next section. If this section is the last one, 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] + * 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. */ - getNextOrNullObject(): Word.Section; + set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ParagraphFormat): 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.SectionLoadOptions): Word.Section; + load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat; /** * 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.Section; + load(propertyNames?: string | string[]): Word.ParagraphFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -13974,1365 +14192,1300 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Section; + }): Word.ParagraphFormat; /** * 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.Section; + track(): Word.ParagraphFormat; /** * 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.Section; + 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.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. + * 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.SectionData; + toJSON(): Word.Interfaces.ParagraphFormatData; } /** - * Contains the collection of the document's {@link Word.Section} objects. + * Represents a contiguous area in a document. * * @remarks * [Api set: WordApi 1.1] */ - export class SectionCollection extends OfficeExtension.ClientObject { + export class Range 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.Section[]; /** - * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Section; + readonly bookmarks: Word.BookmarkCollection; /** - * Gets the first section 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}. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi 1.3] - */ - getFirstOrNullObject(): Word.Section; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.SectionCollection; + readonly conflicts: Word.ConflictCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of content control objects in the range. * - * @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.SectionCollection; - /** - * 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.SectionCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.SectionCollectionData; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export class Setting 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; + readonly contentControls: Word.ContentControlCollection; /** - * Gets the key of the setting. + * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly key: string; + readonly editors: Word.EditorCollection; /** - * Specifies the value of the setting. + * Gets the collection of endnotes in the range. * * @remarks - * [Api set: WordApi 1.4] - */ - value: any; - /** - * 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. + * [Api set: WordApi 1.5] */ - set(properties: Interfaces.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Setting): void; + readonly endnotes: Word.NoteItemCollection; /** - * Deletes the setting. + * Gets the collection of field objects in the range. * * @remarks * [Api set: WordApi 1.4] */ - delete(): 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.SettingLoadOptions): Word.Setting; - /** - * 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.Setting; - /** - * 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.Setting; - /** - * 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.Setting; - /** - * 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.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. - */ - toJSON(): Word.Interfaces.SettingData; - } - /** - * Contains the collection of {@link Word.Setting} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export class SettingCollection 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.Setting[]; + readonly fields: Word.FieldCollection; /** - * Creates a new setting or sets an existing setting. + * 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.4] - * - * @param key - Required. The setting's key, which is case-sensitive. - * @param value - Required. The setting's value. + * [Api set: WordApi 1.1] */ - add(key: string, value: any): Word.Setting; + readonly font: Word.Font; /** - * Deletes all settings in this add-in. + * Gets the collection of footnotes in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - deleteAll(): void; + readonly footnotes: Word.NoteItemCollection; /** - * Gets the count of settings. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getCount(): OfficeExtension.ClientResult; + readonly frames: Word.FrameCollection; /** - * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key - The key that identifies the setting object. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(key: string): Word.Setting; + readonly hyperlinks: Word.HyperlinkCollection; /** - * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, 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}. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key - Required. The key that identifies the setting object. + * [Api set: WordApi 1.2] */ - getItemOrNullObject(key: string): Word.Setting; + readonly inlinePictures: Word.InlinePictureCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; + readonly listFormat: Word.ListFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of list objects in the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.SettingCollection; + readonly lists: Word.ListCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of pages in the range. * - * @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.SettingCollection; - /** - * 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.SettingCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.SettingCollectionData; - } - /** - * Contains a collection of {@link Word.Style} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export class StyleCollection 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.Style[]; + readonly pages: Word.PageCollection; /** - * Get the style object by its name. + * Gets the collection of paragraph objects in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] * - * @param name - Required. The style name. + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. */ - getByName(name: string): Word.Style; + readonly paragraphs: Word.ParagraphCollection; /** - * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + * Gets the parent body of the range. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name - Required. The style name. + * [Api set: WordApi 1.3] */ - getByNameOrNullObject(name: string): Word.Style; + readonly parentBody: Word.Body; /** - * Gets the number of the styles 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.5] + * [Api set: WordApi 1.1] */ - getCount(): OfficeExtension.ClientResult; + readonly parentContentControl: Word.ContentControl; /** - * Gets a style object by its index 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.5] - * - * @param index - A number that identifies the index location of a style object. + * [Api set: WordApi 1.3] */ - getItem(index: number): Word.Style; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; + readonly parentTable: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.StyleCollection; + readonly parentTableCell: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @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.StyleCollection; - /** - * 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.StyleCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.StyleCollectionData; - } - /** - * Represents a style in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class Style 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; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * 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: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - readonly borders: Word.BorderCollection; + readonly parentTableOrNullObject: Word.Table; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets the collection of revisions that represents the tracked changes in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly font: Word.Font; + readonly revisions: Word.RevisionCollection; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly frame: Word.Frame; + readonly sections: Word.SectionCollection; /** - * Specifies a link between a paragraph and a character style. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle: Word.Style; + readonly shading: Word.ShadingUniversal; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - readonly listTemplate: Word.ListTemplate; + readonly shapes: Word.ShapeCollection; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly paragraphFormat: Word.ParagraphFormat; + readonly tableColumns: Word.TableColumnCollection; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Gets the collection of table objects in the range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - readonly shading: Word.Shading; + readonly tables: Word.TableCollection; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly tableStyle: Word.TableStyle; + readonly bold: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate: boolean; + readonly boldBidirectional: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle: string; + case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Gets whether the specified style is a built-in style. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly builtIn: boolean; + characterWidth: Word.CharacterWidth | "Half" | "Full"; /** - * Gets the description of the specified style. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly description: string; + combineCharacters: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing: boolean; + readonly disableCharacterSpaceGrid: boolean; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly inUse: boolean; + readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + end: number; /** - * Specifies an East Asian language for the style. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + fitTextWidth: number; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly linked: boolean; + grammarChecked: boolean; /** - * Returns the list level for the style. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listLevelNumber: number; + hasNoProofing: boolean; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the highlight color for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked: boolean; + readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the name of a style in the language of the user. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly nameLocal: string; + horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * 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. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - nextParagraphStyle: string; + hyperlink: string; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle: boolean; + id: string; /** - * Specifies the priority. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - priority: number; + readonly isEmpty: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle: boolean; + readonly isEndOfRowMark: boolean; /** - * Gets the style type. + * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + readonly isTextVisibleOnScreen: boolean; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed: boolean; + readonly italic: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.5] - */ - visibility: boolean; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Style): void; + readonly italicBidirectional: boolean; /** - * Deletes the style. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + kana: Word.Kana | "Katakana" | "Hiragana"; /** - * Links this style to a list template so that the style's formatting can be applied to lists. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate - A `ListTemplate` to link to the style. - */ - linkToListTemplate(listTemplate: Word.ListTemplate): 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.StyleLoadOptions): Word.Style; + languageDetected: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `LanguageId` value that represents the language for the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Style; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies an East Asian language for the range. * - * @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.Style; - /** - * 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.Style; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.StyleData; - } - /** - * Represents the shading object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export class Shading 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; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor: string; + languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor: string; + showAll: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shading): void; + spellingChecked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the starting character position of the range. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; + start: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the number of characters in the story that contains the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Shading; + readonly storyLength: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the story type for the range. * - * @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.Shading; - /** - * 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.Shading; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShadingData; - } - /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ShadingUniversal 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; + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the style name for the range. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - backgroundPatternColor: string; + style: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Gets the text of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - foregroundPatternColor: string; + readonly text: string; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + readonly underline: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; /** * 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.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadingUniversal): void; + set(properties: Word.Range): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Clears the contents of the range object. The user can perform the undo operation on the cleared content. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; + clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Compares this range's location with another range's location. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ShadingUniversal; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.3] * - * @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.ShadingUniversal; - /** - * 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.ShadingUniversal; - /** - * 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. + * @param range - Required. The range to compare with this range. */ - untrack(): Word.ShadingUniversal; + compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. + * Deletes the range and its content from the document. + * + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.ShadingUniversalData; - } - /** - * Represents a table in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class Table 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; + delete(): void; /** - * Returns the `TableColumnCollection` object that represents the columns in the table. + * Analyzes the range text to determine the language that it's written in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly columns: Word.TableColumnCollection; + detectLanguage(): OfficeExtension.ClientResult; /** - * Gets the collection of endnotes in the table. + * 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.5] - */ - readonly endnotes: Word.NoteItemCollection; - /** - * Gets the collection of field objects in the table. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi 1.4] + * @param range - Required. Another range. */ - readonly fields: Word.FieldCollection; + expandTo(range: Word.Range): Word.Range; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, 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] + * + * @param range - Required. Another range. */ - readonly font: Word.Font; + expandToOrNullObject(range: Word.Range): Word.Range; /** - * Gets the collection of footnotes in the table. + * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] + * + * @param includeHidden - Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent - Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. */ - readonly footnotes: Word.NoteItemCollection; + getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** - * Gets the parent body of the table. + * Gets comments associated with the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * @returns */ - readonly parentBody: Word.Body; + getComments(): Word.CommentCollection; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the currently supported content controls in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options - Optional. Options that define which content controls are returned. */ - readonly parentContentControl: Word.ContentControl; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * 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}. + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + getHtml(): OfficeExtension.ClientResult; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets hyperlink child ranges within the range. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTable: Word.Table; + getHyperlinkRanges(): Word.RangeCollection; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - readonly parentTableCell: Word.TableCell; + getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * 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}. + * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, 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] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - readonly parentTableCellOrNullObject: Word.TableCell; + getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * 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}. + * Gets the OOXML representation of the range object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly parentTableOrNullObject: Word.Table; + getOoxml(): OfficeExtension.ClientResult; /** - * Gets all of the table rows. + * Clones the range, or gets the starting or ending point of the range as a new range. * * @remarks * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. */ - readonly rows: Word.TableRowCollection; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * Returns the `ShadingUniversal` object that represents the shading of the table. + * Gets reviewed text based on ChangeTrackingVersion selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. */ - readonly shading: Word.ShadingUniversal; + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * Gets the child tables nested one level deeper. + * Gets reviewed text based on ChangeTrackingVersion selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion - Optional. The value must be 'Original' or 'Current'. The default is 'Current'. */ - readonly tables: Word.TableCollection; + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks - Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Specifies the description of the table. + * Gets the collection of the TrackedChange objects in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - description: string; + getTrackedChanges(): Word.TrackedChangeCollection; /** - * Specifies the number of header rows. + * Highlights the range temporarily without changing document content. + To highlight the text permanently, set the range's Font.HighlightColor. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - headerRowCount: number; + highlight(): void; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * + * @param name - Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + insertBookmark(name: string): void; /** - * Indicates whether all of the table rows are uniform. + * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param breakType - Required. The break type to add. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - readonly isUniform: boolean; + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * Inserts a floating canvas in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param insertShapeOptions - Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). */ - readonly nestingLevel: number; + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Gets the number of rows in the table. + * Insert a comment on the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param commentText - Required. The comment text to be inserted. + * @returns comment object */ - readonly rowCount: number; + insertComment(commentText: string): Word.Comment; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Wraps the Range object with a content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * + * @param contentControlType - Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. */ - shadingColor: string; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; /** - * Specifies the style name for the table. 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. + * Inserts an endnote. The endnote reference is placed after the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param insertText - Optional. Text to be inserted into the endnote body. The default is "". */ - style: string; + insertEndnote(insertText?: string): Word.NoteItem; /** - * Specifies whether the table has banded columns. + * Inserts a field at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. + * @param text - Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - styleBandedColumns: boolean; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; /** - * Specifies whether the table has banded rows. + * Inserts a field at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation - Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType - Optional. Can be any FieldType constant. The default value is Empty. + * @param text - Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting - Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - styleBandedRows: boolean; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Inserts a document at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * 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'. */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies whether the table has a first column with a special style. + * Inserts a footnote. The footnote reference is placed after the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param insertText - Optional. Text to be inserted into the footnote body. The default is "". */ - styleFirstColumn: boolean; + insertFootnote(insertText?: string): Word.NoteItem; /** - * Specifies whether the table has a last column with a special style. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType - The geometric type of the shape to insert. + * @param insertShapeOptions - Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - styleLastColumn: boolean; + insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies whether the table has a total (last) row with a special style. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType - The geometric type of the shape to insert. + * @param insertShapeOptions - Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - styleTotalRow: boolean; + insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the title of the table. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - title: string; - /** - * Specifies the text values in the table, as a 2D JavaScript array. + * [Api set: WordApi 1.1] * - * @remarks - * [Api set: WordApi 1.3] + * @param html - Required. The HTML to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - values: string[][]; + insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Inserts a picture at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; /** - * Specifies the width of the table in points. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param ooxml - Required. The OOXML to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - width: number; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * 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. + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. */ - set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Table): void; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * Inserts a floating picture in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] * - * @param insertLocation - Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. - * @param columnCount - Required. Number of columns to add. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param base64EncodedImage - Required. The Base64-encoded image to be inserted. + * @param insertShapeOptions - Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ - addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; + insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * Inserts a table with the specified number of rows and columns. * * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation - Required. It must be 'Start' or 'End'. - * @param rowCount - Required. Number of rows to add. + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Before' or 'After'. * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Applies the specified style but maintains any formatting that a user directly applies. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param styleName - The name of the style to apply. + * @param text - Required. Text to be inserted. + * @param insertLocation - Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - applyStyleDirectFormatting(styleName: string): void; + insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * Inserts a floating text box in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param behavior - How Word resizes the specified table with the AutoFit feature is used. + * @param text - Optional. The text to insert into the text box. + * @param insertShapeOptions - Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). */ - autoFitBehavior(behavior: Word.AutoFitBehavior): void; + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param behavior - How Word resizes the specified table with the AutoFit feature is used. + * @param range - Required. Another range. */ - autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; + intersectWith(range: Word.Range): Word.Range; /** - * Autofits the table columns to the width of the window. + * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, 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] + * + * @param range - Required. Another range. */ - autoFitWindow(): void; + intersectWithOrNullObject(range: Word.Range): Word.Range; /** - * Applies a predefined look to a table. + * Removes the highlight added by the Highlight function if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - Optional. An object that specifies the options for applying the table format. + * [Api set: WordApi 1.8] */ - autoFormat(options?: Word.TableAutoFormatOptions): void; + removeHighlight(): void; /** - * Clears the contents of the table. + * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. */ - clear(): void; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Converts a table to text. + * Selects and navigates the Word UI to the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param options - An object that specifies the options for converting the table to text. - * @returns A `Range` object that represents the converted text. + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; + select(selectionMode?: Word.SelectionMode): void; /** - * Deletes the entire table. + * Selects and navigates the Word UI to the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - delete(): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Deletes specific columns. This is applicable to uniform tables. + * Splits the range into child ranges by using delimiters. * * @remarks * [Api set: WordApi 1.3] * - * @param columnIndex - Required. The first column to delete. - * @param columnCount - Optional. The number of columns to delete. Default 1. + * @param delimiters - Required. The delimiters as an array of strings. + * @param multiParagraphs - Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters - Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing - Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - deleteColumns(columnIndex: number, columnCount?: number): void; + split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** - * Deletes specific rows. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.RangeLoadOptions): Word.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param rowIndex - Required. The first row to delete. - * @param rowCount - Optional. The number of rows to delete. Default 1. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - deleteRows(rowIndex: number, rowCount?: number): void; + load(propertyNames?: string | string[]): Word.Range; /** - * Distributes the column widths evenly. This is applicable to uniform tables. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - distributeColumns(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Range; /** - * Gets the border style for the specified border. + * Occurs when new comments are added. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param borderLocation - Required. The border location. + * @eventproperty + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + readonly onCommentAdded: OfficeExtension.EventHandlers; /** - * Gets the border style for the specified border. + * Occurs when a comment or its reply is changed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param borderLocation - Required. The border location. + * @eventproperty + * @beta */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + readonly onCommentChanged: OfficeExtension.EventHandlers; /** - * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. + * Occurs when a comment is deselected. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param rowIndex - Required. The index of the row. - * @param cellIndex - Required. The index of the cell in the row. + * @eventproperty + * @beta */ - getCell(rowIndex: number, cellIndex: number): Word.TableCell; + readonly onCommentDeselected: OfficeExtension.EventHandlers; /** - * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, 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}. + * Occurs when a comment is selected. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param rowIndex - Required. The index of the row. - * @param cellIndex - Required. The index of the cell in the row. + * @eventproperty + * @beta */ - getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; + readonly onCommentSelected: OfficeExtension.EventHandlers; /** - * Gets cell padding in points. + * 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.Range; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeData; + } + /** + * Contains a collection of {@link Word.Range} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class RangeCollection 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.Range[]; + /** + * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + getFirst(): Word.Range; /** - * Gets cell padding in points. + * Gets the first range 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 1.3] + */ + getFirstOrNullObject(): Word.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param options - Provides options for which properties of the object to load. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; /** - * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - getNext(): Word.Table; + load(propertyNames?: string | string[]): Word.RangeCollection; /** - * Gets the next table. If this table is the last one, 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getNextOrNullObject(): Word.Table; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection; /** - * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * 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.RangeCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeCollectionData; + } + /** + * Specifies the options to determine location and size when inserting a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export interface InsertShapeOptions { + /** + * Represents the height of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getParagraphAfter(): Word.Paragraph; + height?: number; /** - * Gets the paragraph after the table. If there isn't a paragraph after the 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}. + * Represents the left position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getParagraphAfterOrNullObject(): Word.Paragraph; + left?: number; /** - * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * Represents the top position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getParagraphBefore(): Word.Paragraph; + top?: number; /** - * Gets the paragraph before the table. If there isn't a paragraph before the 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}. + * Represents the width of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getParagraphBeforeOrNullObject(): Word.Paragraph; + width?: number; + } + /** + * Specifies the options to determine what to copy when inserting a file. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface InsertFileOptions { /** - * Gets the range that contains this table, or the range at the start or end of the table. + * Represents whether the change tracking mode status from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + * [Api set: WordApi 1.5] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + importChangeTrackingMode?: boolean; /** - * Inserts a content control on the table. + * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - insertContentControl(): Word.ContentControl; + importCustomProperties?: boolean; /** - * Inserts a paragraph at the specified location. + * Represents whether the custom XML parts from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param paragraphText - Required. The paragraph text to be inserted. - * @param insertLocation - Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.6] */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + importCustomXmlParts?: boolean; /** - * Inserts a table with the specified number of rows and columns. + * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rowCount - Required. The number of rows in the table. - * @param columnCount - Required. The number of columns in the table. - * @param insertLocation - Required. The value must be 'Before' or 'After'. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * [Api set: WordApi 1.7] */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + importDifferentOddEvenPages?: boolean; /** - * Merges the cells bounded inclusively by a first and last cell. + * Represents whether the page color and other background information from the source document should be imported. * * @remarks - * [Api set: WordApi 1.4] - * - * @param topRow - Required. The row of the first cell - * @param firstCell - Required. The index of the first cell in its row - * @param bottomRow - Required. The row of the last cell - * @param lastCell - Required. The index of the last cell in its row + * [Api set: WordApi 1.5] */ - mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + importPageColor?: boolean; /** - * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. + * Represents whether the paragraph spacing from the source document should be imported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - reapplyAutoFormat(): void; + importParagraphSpacing?: boolean; /** - * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. + * Represents whether the styles from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param searchText - Required. The search text. - * @param searchOptions - Optional. Options for the search. + * [Api set: WordApi 1.5] */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + importStyles?: boolean; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Represents whether the theme from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi 1.5] */ - select(selectionMode?: Word.SelectionMode): void; + importTheme?: boolean; + } + /** + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class SearchOptions 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; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi 1.1] */ - select(selectionMode?: "Select" | "Start" | "End"): void; + ignorePunct: boolean; /** - * Sets cell padding in points. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + */ + ignoreSpace: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @remarks + * [Api set: WordApi 1.1] */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + matchCase: boolean; /** - * Sets cell padding in points. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + */ + matchPrefix: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @remarks + * [Api set: WordApi 1.1] */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + matchSuffix: boolean; /** - * Sorts the specified table. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + */ + matchWholeWord: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * - * @param options - An object that specifies the options for sorting the table. + * @remarks + * [Api set: WordApi 1.1] */ - sort(options?: Word.TableSortOptions): void; + matchWildcards: boolean; + /** + * 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.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.SearchOptions): 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.TableLoadOptions): Word.Table; + load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions; /** * 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.Table; + load(propertyNames?: string | string[]): Word.SearchOptions; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -15341,175 +15494,207 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Table; - /** - * 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.Table; + }): Word.SearchOptions; /** - * 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. + * Create a new instance of the `Word.SearchOptions` object. */ - untrack(): Word.Table; + 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.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. + * 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.TableData; + toJSON(): Word.Interfaces.SearchOptionsData; } /** - * Represents the TableStyle object. + * Specifies the options to be included in a getText operation. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.7] */ - export class TableStyle 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; - /** - * Returns a `BorderUniversalCollection` that represents all the borders for the table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly borders: Word.BorderUniversalCollection; + export interface GetTextOptions { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. + * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - readonly shading: Word.Shading; + includeHiddenText?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.7] */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + includeTextMarkedAsDeleted?: boolean; + } + /** + * Specifies the options to be included in a compare document operation. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface DocumentCompareOptions { /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * True adds the document to the list of recently used files on the File menu. The default value is True. * * @remarks * [Api set: WordApiDesktop 1.1] */ - allowBreakAcrossPage: boolean; + addToRecentFiles?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * The reviewer name associated with the differences generated by the comparison. + If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - bottomCellMargin: number; + authorName?: string; /** - * Specifies the spacing (in points) between the cells in a table style. + * The target document for the comparison. Default value is 'CompareTargetCurrent'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - cellSpacing: number; + compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * True (default) for the comparison to include detection of format changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - columnStripe: number; + detectFormatChanges?: boolean; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * True compares the documents without notifying a user of problems. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isBreakAcrossPagesAllowed: boolean; + ignoreAllComparisonWarnings?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - leftCellMargin: number; + removeDateAndTime?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - leftIndent: number; + removePersonalInformation?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export class Section 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; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - rightCellMargin: number; + readonly body: Word.Body; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe: number; + readonly borders: Word.BorderUniversalCollection; /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; + readonly pageSetup: Word.PageSetup; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin: number; + protectedForForms: boolean; /** * 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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableStyle): void; + set(properties: Word.Section): void; /** - * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param conditionCode - The area of the table to which to apply the formatting. + * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. */ - condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; + getFooter(type: Word.HeaderFooterType): Word.Body; /** - * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param conditionCode - The area of the table to which to apply the formatting. + * @param type - Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. */ - condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; + getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: Word.HeaderFooterType): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type - Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.Section; + /** + * Gets the next section. If this section is the last one, 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] + */ + getNextOrNullObject(): Word.Section; /** * 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.TableStyleLoadOptions): Word.TableStyle; + load(options?: Word.Interfaces.SectionLoadOptions): Word.Section; /** * 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.TableStyle; + load(propertyNames?: string | string[]): Word.Section; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -15518,99 +15703,128 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableStyle; + }): Word.Section; /** * 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.TableStyle; + track(): Word.Section; /** * 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.TableStyle; + 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.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. + * 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.TableStyleData; + toJSON(): Word.Interfaces.SectionData; } /** - * Represents a tab stop in a Word document. + * Contains the collection of the document's {@link Word.Section} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - export class TabStop extends OfficeExtension.ClientObject { + export class SectionCollection 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.Section[]; /** - * Gets the next tab stop in the collection. + * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly next: Word.TabStop; + getFirst(): Word.Section; /** - * Gets the previous tab stop in the collection. + * Gets the first section 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 + * [Api set: WordApi 1.3] */ - readonly previous: Word.TabStop; + getFirstOrNullObject(): Word.Section; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; /** - * Gets whether this tab stop is a custom tab stop. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly customTab: boolean; + load(propertyNames?: string | string[]): Word.SectionCollection; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * 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.SectionCollection; + /** + * 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.SectionCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SectionCollectionData; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export class Setting 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + readonly key: string; /** - * Gets the position of the tab stop relative to the left margin. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly position: number; + value: any; /** - * Removes this custom tab stop. + * 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.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Setting): void; + /** + * Deletes the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - clear(): void; + delete(): 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.TabStopLoadOptions): Word.TabStop; + load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting; /** * 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.TabStop; + load(propertyNames?: string | string[]): Word.Setting; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -15619,620 +15833,598 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TabStop; + }): Word.Setting; /** * 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.TabStop; + track(): Word.Setting; /** * 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.TabStop; + 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.TabStop` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopData`) that contains shallow copies of any loaded child properties from the original object. + * 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.TabStopData; + toJSON(): Word.Interfaces.SettingData; } /** - * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * Contains the collection of {@link Word.Setting} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - export class TabStopCollection extends OfficeExtension.ClientObject { + export class SettingCollection 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.TabStop[]; + readonly items: Word.Setting[]; /** - * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. + * Creates a new setting or sets an existing setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] * - * @param position - The position of the tab stop. - * @param options - Optional. The options to further configure the new tab stop. + * @param key - Required. The setting's key, which is case-sensitive. + * @param value - Required. The setting's value. */ - add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; + add(key: string, value: any): Word.Setting; /** - * Returns the next `TabStop` object to the right of the specified position. + * Deletes all settings in this add-in. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param Position - The position to check. + * [Api set: WordApi 1.4] */ - after(Position: number): Word.TabStop; + deleteAll(): void; /** - * Returns the next `TabStop` object to the left of the specified position. + * Gets the count of settings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param Position - The position to check. + * [Api set: WordApi 1.4] */ - before(Position: number): Word.TabStop; + getCount(): OfficeExtension.ClientResult; /** - * Clears all the custom tab stops from the paragraph. + * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * @param key - The key that identifies the setting object. */ - clearAll(): void; + getItem(key: string): Word.Setting; /** - * Gets a `TabStop` object by its index in the collection. + * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, 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 + * [Api set: WordApi 1.4] * - * @param index - A number that identifies the index location of a `TabStop` object. + * @param key - Required. The key that identifies the setting object. */ - getItem(index: number): Word.TabStop; + getItemOrNullObject(key: string): Word.Setting; /** * 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.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; + load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; /** * 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.TabStopCollection; + load(propertyNames?: string | string[]): Word.SettingCollection; /** * 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.TabStopCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection; /** * 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.TabStopCollection; + track(): Word.SettingCollection; /** * 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.TabStopCollection; + 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.TabStopCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TabStopCollectionData; + toJSON(): Word.Interfaces.SettingCollectionData; } /** - * Specifies the options for adding to a {@link Word.TabStopCollection} object. + * Contains a collection of {@link Word.Style} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - export interface TabStopAddOptions { + export class StyleCollection 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.Style[]; /** - * If provided, specifies the alignment of the tab stop. The default value is `left`. + * Get the style object by its name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * @param name - Required. The style name. */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + getByName(name: string): Word.Style; /** - * If provided, specifies the leader character for the tab stop. The default value is `spaces`. + * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * @param name - Required. The style name. */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** - * Contains the collection of the document's Table objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class TableCollection 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.Table[]; + getByNameOrNullObject(name: string): Word.Style; /** - * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the number of the styles in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getFirst(): Word.Table; + getCount(): OfficeExtension.ClientResult; /** - * Gets the first table 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}. + * Gets a style object by its index in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param index - A number that identifies the index location of a style object. */ - getFirstOrNullObject(): Word.Table; + getItem(index: number): Word.Style; /** * 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.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; + load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; /** * 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.TableCollection; + load(propertyNames?: string | string[]): Word.StyleCollection; /** * 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.TableCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.StyleCollection; /** * 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.TableCollection; + track(): Word.StyleCollection; /** * 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.TableCollection; + 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.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. + * 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.TableCollectionData; + toJSON(): Word.Interfaces.StyleCollectionData; } /** - * Represents a table column in a Word document. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export class TableColumn extends OfficeExtension.ClientObject { + export class Style 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; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - readonly borders: Word.BorderUniversalCollection; + readonly borders: Word.BorderCollection; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly shading: Word.ShadingUniversal; + readonly font: Word.Font; /** - * Returns the position of this column in a collection. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly columnIndex: number; + readonly frame: Word.Frame; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isFirst: boolean; + linkStyle: Word.Style; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - readonly isLast: boolean; + readonly listTemplate: Word.ListTemplate; /** - * Returns the nesting level of the column. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly nestingLevel: number; + readonly paragraphFormat: Word.ParagraphFormat; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - preferredWidth: number; + readonly shading: Word.Shading; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + readonly tableStyle: Word.TableStyle; /** - * Specifies the width of the column, in points. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width: number; + automaticallyUpdate: boolean; /** - * 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. + * Specifies the name of an existing style to use as the base formatting of another style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableColumn): void; + baseStyle: string; /** - * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - autoFit(): void; + readonly builtIn: boolean; /** - * Deletes the column. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + readonly description: string; /** - * Selects the table column. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + hasProofing: boolean; /** - * Sets the width of the column in a table. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param columnWidth - The width to set. - * @param rulerStyle - The ruler style to apply. + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + readonly inUse: boolean; /** - * Sets the width of the column in a table. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param columnWidth - The width to set. - * @param rulerStyle - The ruler style to apply. */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Sorts the table column. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sort(): void; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; + readonly linked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the list level for the style. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableColumn; + readonly listLevelNumber: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the style cannot be changed or edited. * - * @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.TableColumn; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TableColumn; + locked: boolean; /** - * 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. + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.TableColumn; + readonly nameLocal: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - toJSON(): Word.Interfaces.TableColumnData; - } - /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TableColumnCollection 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.TableColumn[]; + nextParagraphStyle: string; /** - * Returns a `TableColumn` object that represents a column added to a table. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param beforeColumn - Optional. The column before which the new column is added. - * @returns A new `TableColumn` object. */ - add(beforeColumn?: Word.TableColumn): Word.TableColumn; + noSpaceBetweenParagraphsOfSameStyle: boolean; /** - * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * Specifies the priority. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - autoFit(): void; + priority: number; /** - * Deletes the specified columns. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - delete(): void; + quickStyle: boolean; /** - * Adjusts the width of the specified columns so that they are equal. + * Gets the style type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - distributeWidth(): void; + readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Selects the specified table columns. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - select(): void; + unhideWhenUsed: boolean; /** - * Sets the width of columns in a table. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + */ + visibility: boolean; + /** + * 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.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Style): void; + /** + * Deletes the style. * - * @param columnWidth - The width to set. - * @param rulerStyle - The ruler style to apply. + * @remarks + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + delete(): void; /** - * Sets the width of columns in a table. + * Links this style to a list template so that the style's formatting can be applied to lists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param columnWidth - The width to set. - * @param rulerStyle - The ruler style to apply. + * @param listTemplate - A `ListTemplate` to link to the style. */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + linkToListTemplate(listTemplate: Word.ListTemplate): 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.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; + load(options?: Word.Interfaces.StyleLoadOptions): Word.Style; /** * 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.TableColumnCollection; + load(propertyNames?: string | string[]): Word.Style; /** * 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.TableColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Style; /** * 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.TableColumnCollection; + track(): Word.Style; /** * 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.TableColumnCollection; + 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableColumnCollectionData; + toJSON(): Word.Interfaces.StyleData; } /** - * Represents a table of authorities in a Word document. + * Represents the shading object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - export class TableOfAuthorities extends OfficeExtension.ClientObject { + export class Shading 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 portion of a document that is this table of authorities. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - readonly range: Word.Range; + backgroundPatternColor: string; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bookmark: string; + foregroundPatternColor: string; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - category: number; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - entrySeparator: string; + set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shading): void; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - isCategoryHeaderIncluded: boolean; + load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - isEntryFormattingKept: boolean; + load(propertyNames?: string | string[]): Word.Shading; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isPassimUsed: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shading; /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * 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.Shading; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ShadingData; + } + /** + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ShadingUniversal 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; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator: string; + backgroundPatternColor: string; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator: string; + backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName: string; + foregroundPatternColor: string; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator: string; + foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** * 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.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfAuthorities): void; - /** - * Deletes this table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - delete(): void; + set(properties: Word.ShadingUniversal): 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.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; + load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + load(propertyNames?: string | string[]): Word.ShadingUniversal; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -16241,2354 +16433,2464 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableOfAuthorities; + }): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + track(): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + untrack(): Word.ShadingUniversal; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableOfAuthoritiesData; + toJSON(): Word.Interfaces.ShadingUniversalData; } /** - * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. + * Represents a table in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export class TableOfAuthoritiesCollection extends OfficeExtension.ClientObject { + export class Table 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.TableOfAuthorities[]; /** - * Adds a table of authorities to the document at the specified range. + * Returns the `TableColumnCollection` object that represents the columns in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. - * @param options - Optional. The options to configure the table of authorities. */ - add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; + readonly columns: Word.TableColumnCollection; /** - * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. + * Gets the collection of endnotes in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param shortCitation - The citation text to mark. - * @param options - Optional. The options for marking the citation. + * [Api set: WordApi 1.5] */ - markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; + readonly endnotes: Word.NoteItemCollection; /** - * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param range - The range where the citation will be inserted. - * @param shortCitation - The short citation text. - * @param options - Optional. The options for marking the citation. + * [Api set: WordApi 1.4] */ - markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; + readonly fields: Word.FieldCollection; /** - * Finds and selects the next instance of the specified citation text. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param shortCitation - The citation text to search for. + * [Api set: WordApi 1.3] */ - selectNextCitation(shortCitation: string): void; + readonly font: Word.Font; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of footnotes in the table. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; + readonly footnotes: Word.NoteItemCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the parent body of the table. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; + readonly parentBody: Word.Body; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * - * @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.TableOfAuthoritiesCollection; - /** - * 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. + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableOfAuthoritiesCollection; + readonly parentContentControl: Word.ContentControl; /** - * 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. + * 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] */ - untrack(): Word.TableOfAuthoritiesCollection; + readonly parentContentControlOrNullObject: 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.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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] */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; - } - /** - * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TableOfAuthoritiesAddOptions { + readonly parentTable: Word.Table; /** - * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. - When specified, the entries are collected only from the portion of the document marked by the bookmark. - Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookmark?: string; + readonly parentTableCell: Word.TableCell; /** - * If provided, specifies the category of entries to include in a table of authorities. - Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. - The default value is `1`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - category?: number; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. - Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, no separator is used. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - entrySeparator?: string; + readonly parentTableOrNullObject: Word.Table; /** - * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). - Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `true`. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - includeCategoryHeader?: boolean; + readonly rows: Word.TableRowCollection; /** - * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. - Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `true`. + * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - keepEntryFormatting?: boolean; + readonly shading: Word.ShadingUniversal; /** - * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. - Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, a comma and a space (", ") are used. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageNumberSeparator?: string; + readonly tables: Word.TableCollection; /** - * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. - Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, an en dash ("–") is used. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageRangeSeparator?: string; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. - Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName?: string; + description: string; /** - * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. - Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, a hyphen ("-") is used. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sequenceSeparator?: string; + headerRowCount: number; /** - * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". - Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `false`. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - usePassim?: boolean; - } - /** - * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TableOfAuthoritiesMarkCitationOptions { + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies the category number to be associated with the entry. - Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. - The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. - To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - category?: number; + readonly isUniform: boolean; /** - * If provided, specifies the long citation for the entry as it will appear in a table of authorities. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - longCitation?: string; + readonly nestingLevel: number; /** - * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - longCitationAutoText?: string; - } - /** - * Represents a category used in a table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TableOfAuthoritiesCategory 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; + readonly rowCount: number; /** - * Specifies the name of this table of authorities category. - Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly name: string; + shadingColor: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the style name for the table. 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. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; + style: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the table has banded columns. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; + styleBandedColumns: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the table has banded rows. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableOfAuthoritiesCategory; + styleBandedRows: boolean; /** - * 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. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableOfAuthoritiesCategory; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * 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. + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.TableOfAuthoritiesCategory; + styleFirstColumn: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; - } - /** - * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TableOfAuthoritiesCategoryCollection 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.TableOfAuthoritiesCategory[]; + styleLastColumn: boolean; /** - * Returns the number of items in the collection. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - getCount(): OfficeExtension.ClientResult; + styleTotalRow: boolean; /** - * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The index of the item to retrieve. */ - getItemAt(index: number): Word.TableOfAuthoritiesCategory; + title: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the text values in the table, as a 2D JavaScript array. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; + values: string[][]; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of the table in points. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; + width: number; /** - * 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. + * 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. */ - track(): Word.TableOfAuthoritiesCategoryCollection; + set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Table): void; /** - * 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. + * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. + * @param columnCount - Required. Number of columns to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - untrack(): Word.TableOfAuthoritiesCategoryCollection; + addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Start' or 'End'. + * @param rowCount - Required. Number of rows to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; - } - /** - * Represents a table of contents in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TableOfContents 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; + addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. + * Applies the specified style but maintains any formatting that a user directly applies. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param styleName - The name of the style to apply. */ - readonly additionalHeadingStyles: Word.HeadingStyleCollection; + applyStyleDirectFormatting(styleName: string): void; /** - * Gets the portion of a document that is this table of contents. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param behavior - How Word resizes the specified table with the AutoFit feature is used. */ - readonly range: Word.Range; + autoFitBehavior(behavior: Word.AutoFitBehavior): void; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param behavior - How Word resizes the specified table with the AutoFit feature is used. */ - areBuiltInHeadingStylesUsed: boolean; + autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Autofits the table columns to the width of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areFieldsUsed: boolean; + autoFitWindow(): void; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Applies a predefined look to a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. An object that specifies the options for applying the table format. */ - areHyperlinksUsedOnWeb: boolean; + autoFormat(options?: Word.TableAutoFormatOptions): void; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Clears the contents of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - arePageNumbersHiddenOnWeb: boolean; + clear(): void; /** - * Specifies whether page numbers are included in the table of contents. + * Converts a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - An object that specifies the options for converting the table to text. + * @returns A `Range` object that represents the converted text. */ - arePageNumbersIncluded: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Deletes the entire table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - arePageNumbersRightAligned: boolean; + delete(): void; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Deletes specific columns. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param columnIndex - Required. The first column to delete. + * @param columnCount - Optional. The number of columns to delete. Default 1. */ - lowerHeadingLevel: number; + deleteColumns(columnIndex: number, columnCount?: number): void; /** - * Specifies the character between entries and their page numbers in the table of contents. + * Deletes specific rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rowIndex - Required. The first row to delete. + * @param rowCount - Optional. The number of rows to delete. Default 1. */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + deleteRows(rowIndex: number, rowCount?: number): void; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Distributes the column widths evenly. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tableId: string; + distributeColumns(): void; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - upperHeadingLevel: number; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * 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. + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfContents): void; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Deletes this table of contents. + * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rowIndex - Required. The index of the row. + * @param cellIndex - Required. The index of the cell in the row. */ - delete(): void; + getCell(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Updates the entire table of contents. + * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, 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 + * [Api set: WordApi 1.3] + * + * @param rowIndex - Required. The index of the row. + * @param cellIndex - Required. The index of the cell in the row. + */ + getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Updates only the page numbers for items in this table of contents. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - updatePageNumbers(): void; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets cell padding in points. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfContents; + getNext(): Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next table. If this table is the last one, 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}. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableOfContents; + getNextOrNullObject(): Word.Table; /** - * 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. + * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableOfContents; + getParagraphAfter(): Word.Paragraph; /** - * 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. + * Gets the paragraph after the table. If there isn't a paragraph after the 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] */ - untrack(): Word.TableOfContents; + getParagraphAfterOrNullObject(): 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.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. + * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TableOfContentsData; - } - /** - * Represents a collection of {@link Word.TableOfContents} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TableOfContentsCollection 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.TableOfContents[]; + getParagraphBefore(): Word.Paragraph; /** - * Adds a table of contents to the document at the specified range. + * Gets the paragraph before the table. If there isn't a paragraph before the 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] + */ + getParagraphBeforeOrNullObject(): Word.Paragraph; + /** + * Gets the range that contains this table, or the range at the start or end of the table. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation - Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + /** + * Inserts a content control on the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + insertContentControl(): Word.ContentControl; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param paragraphText - Required. The paragraph text to be inserted. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount - Required. The number of rows in the table. + * @param columnCount - Required. The number of columns in the table. + * @param insertLocation - Required. The value must be 'Before' or 'After'. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Merges the cells bounded inclusively by a first and last cell. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param topRow - Required. The row of the first cell + * @param firstCell - Required. The index of the first cell in its row + * @param bottomRow - Required. The row of the last cell + * @param lastCell - Required. The index of the last cell in its row + */ + mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + reapplyAutoFormat(): void; + /** + * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. * - * @param range - The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. - * @param options - Optional. The options for configuring the table of contents. + * @remarks + * [Api set: WordApi 1.3] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. */ - add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Sorts the specified table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param range - The range where the entry will be inserted. - * @param options - Optional. The options for marking the table of contents entry. + * @param options - An object that specifies the options for sorting the table. */ - markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; + sort(options?: Word.TableSortOptions): 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.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; + load(options?: Word.Interfaces.TableLoadOptions): Word.Table; /** * 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.TableOfContentsCollection; + load(propertyNames?: string | string[]): Word.Table; /** * 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.TableOfContentsCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Table; /** * 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.TableOfContentsCollection; + track(): Word.Table; /** * 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.TableOfContentsCollection; + 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.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableOfContentsCollectionData; + toJSON(): Word.Interfaces.TableData; } /** - * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. + * Represents the TableStyle object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - export interface TableOfContentsAddOptions { + export class TableStyle 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; /** - * If provided, specifies the string names of additional styles to use for the table of contents. - Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. + * Returns a `BorderUniversalCollection` that represents all the borders for the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - addedStyles?: string; + readonly borders: Word.BorderUniversalCollection; /** - * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. - The default value is `true`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hidePageNumbersOnWeb?: boolean; + readonly shading: Word.Shading; /** - * If provided, specifies whether to include page numbers in a table of contents. - The default value is `true`. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - includePageNumbers?: boolean; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. - Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - The default value is `9`. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lowerHeadingLevel?: number; + allowBreakAcrossPage: boolean; /** - * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. - The default value is `true`. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - rightAlignPageNumbers?: boolean; + bottomCellMargin: number; /** - * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. - Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. - If this argument is omitted, TC fields aren't used. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - tableId?: string; + cellSpacing: number; /** - * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. - Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - The default value is `1`. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; + columnStripe: number; /** - * If provided, specifies whether to use built-in heading styles to create a table of contents. - The default value is `true`. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useBuiltInHeadingStyles?: boolean; + isBreakAcrossPagesAllowed: boolean; /** - * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. - Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. - The default value is `false`. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - useFields?: boolean; + leftCellMargin: number; /** - * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. - The default value is `true`. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useHyperlinksOnWeb?: boolean; + leftIndent: number; /** - * If provided, specifies whether to use outline levels to create a table of contents. - The default value is `false`. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - useOutlineLevels?: boolean; - } - /** - * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TableOfContentsMarkEntryOptions { + rightCellMargin: number; /** - * If provided, specifies the text that appears in a table of contents or table of figures. - To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). - When the `entryAutoText` property is set, this property is ignored. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + rowStripe: number; /** - * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. - When this property is used, the `entry` property is ignored. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin: 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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableStyle): void; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param conditionCode - The area of the table to which to apply the formatting. */ - level?: number; + condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; /** - * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param conditionCode - The area of the table to which to apply the formatting. */ - tableId?: string; + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; + /** + * 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.TableStyleLoadOptions): Word.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableStyleData; } /** - * Represents a table of figures in a Word document. + * Represents a tab stop in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class TableOfFigures extends OfficeExtension.ClientObject { + export class TabStop 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 additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. + * Gets the next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly additionalHeadingStyles: Word.HeadingStyleCollection; + readonly next: Word.TabStop; /** - * Gets the portion of a document that is this table of figures. + * Gets the previous tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + readonly previous: Word.TabStop; /** - * Specifies whether built-in heading styles are used for the table of figures. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed: boolean; + readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed: boolean; + readonly customTab: boolean; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb: boolean; + readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb: boolean; + readonly position: number; /** - * Specifies whether page numbers are included in the table of figures. + * Removes this custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded: boolean; + clear(): void; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - arePageNumbersRightAligned: boolean; + load(options?: Word.Interfaces.TabStopLoadOptions): Word.TabStop; /** - * Specifies the label that identifies the items to be included in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - captionLabel: string; + load(propertyNames?: string | string[]): Word.TabStop; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isLabelIncluded: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TabStop; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lowerHeadingLevel: number; + track(): Word.TabStop; /** - * Specifies the character between entries and their page numbers in the table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + untrack(): Word.TabStop; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TabStop` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TabStopData; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TabStopCollection 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.TabStop[]; + /** + * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param position - The position of the tab stop. + * @param options - Optional. The options to further configure the new tab stop. */ - tableId: string; + add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Returns the next `TabStop` object to the right of the specified position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param Position - The position to check. */ - upperHeadingLevel: 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.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfFigures): void; + after(Position: number): Word.TabStop; /** - * Deletes this table of figures. + * Returns the next `TabStop` object to the left of the specified position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param Position - The position to check. */ - delete(): void; + before(Position: number): Word.TabStop; /** - * Updates the entire table of figures. + * Clears all the custom tab stops from the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + clearAll(): void; /** - * Updates only the page numbers for items in this table of figures. + * Gets a `TabStop` object by its index in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - A number that identifies the index location of a `TabStop` object. */ - updatePageNumbers(): void; + getItem(index: number): Word.TabStop; /** * 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.TableOfFiguresLoadOptions): Word.TableOfFigures; + load(options?: Word.Interfaces.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; /** * 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.TableOfFigures; + load(propertyNames?: string | string[]): Word.TabStopCollection; /** * 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.TableOfFigures; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TabStopCollection; /** * 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.TableOfFigures; + track(): Word.TabStopCollection; /** * 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.TableOfFigures; + untrack(): Word.TabStopCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TabStopCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableOfFiguresData; + toJSON(): Word.Interfaces.TabStopCollectionData; } /** - * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. + * Specifies the options for adding to a {@link Word.TabStopCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class TableOfFiguresCollection 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.TableOfFigures[]; + export interface TabStopAddOptions { /** - * Adds a table of figures to the document at the specified range. + * If provided, specifies the alignment of the tab stop. The default value is `left`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. - * @param options - Optional. The options for configuring the table of figures. */ - add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. + * If provided, specifies the leader character for the tab stop. The default value is `spaces`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** + * Contains the collection of the document's Table objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableCollection 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.Table[]; + /** + * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. * - * @param range - The range where the TC field will be inserted. - * @param options - Optional. The options for marking the entry. + * @remarks + * [Api set: WordApi 1.3] */ - markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; + getFirst(): Word.Table; + /** + * Gets the first table 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 1.3] + */ + getFirstOrNullObject(): Word.Table; /** * 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.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; + load(options?: Word.Interfaces.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; /** * 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.TableOfFiguresCollection; + load(propertyNames?: string | string[]): Word.TableCollection; /** * 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.TableOfFiguresCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection; /** * 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.TableOfFiguresCollection; + track(): Word.TableCollection; /** * 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.TableOfFiguresCollection; + 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.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableOfFiguresCollectionData; + toJSON(): Word.Interfaces.TableCollectionData; } /** - * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableOfFiguresAddOptions { + export class TableColumn 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; /** - * If provided, specifies the string names of additional styles to use for the table of figures. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - addedStyles?: string; + readonly borders: Word.BorderUniversalCollection; /** - * If provided, specifies the label that identifies the items to include in a table of figures. - * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is "Figure". + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - captionLabel?: string; + readonly shading: Word.ShadingUniversal; /** - * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. - * The default value is `true`. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hidePageNumbersOnWeb?: boolean; + readonly columnIndex: number; /** - * If provided, specifies whether to include the caption label and caption number in a table of figures. - * The default value is `true`. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includeLabel?: boolean; + readonly isFirst: boolean; /** - * If provided, specifies whether page numbers are included in a table of figures. - * The default value is `true`. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includePageNumbers?: boolean; + readonly isLast: boolean; /** - * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. - * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `9`. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + readonly nestingLevel: number; /** - * If provided, specifies whether to align page numbers with the right margin in a table of figures. - * The default value is `true`. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + preferredWidth: number; /** - * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. - * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. - * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `1`. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; + width: number; /** - * If provided, specifies whether to use built-in heading styles to create a table of figures. - * The default value is `false`. + * 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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableColumn): void; + /** + * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useBuiltInHeadingStyles?: boolean; + autoFit(): void; /** - * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. - * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. - * The default value is `false`. + * Deletes the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useFields?: boolean; + delete(): void; /** - * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. - * The default value is `true`. + * Selects the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useHyperlinksOnWeb?: boolean; - } - /** - * Represents a row in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class TableRow 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; + select(): void; /** - * Gets cells. + * Sets the width of the column in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width to set. + * @param rulerStyle - The ruler style to apply. */ - readonly cells: Word.TableCellCollection; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Gets the collection of endnotes in the table row. + * Sets the width of the column in a table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width to set. + * @param rulerStyle - The ruler style to apply. */ - readonly endnotes: Word.NoteItemCollection; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Gets the collection of field objects in the table row. + * Sorts the table column. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly fields: Word.FieldCollection; + sort(): void; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. */ - readonly font: Word.Font; + load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; /** - * Gets the collection of footnotes in the table row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly footnotes: Word.NoteItemCollection; + load(propertyNames?: string | string[]): Word.TableColumn; /** - * Gets parent table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - readonly parentTable: Word.Table; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableColumn; /** - * Returns the `Range` object that represents the table row. + * 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.TableColumn; + /** + * 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.TableColumn; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableColumnData; + } + /** + * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableColumnCollection 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.TableColumn[]; + /** + * Returns a `TableColumn` object that represents a column added to a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param beforeColumn - Optional. The column before which the new column is added. + * @returns A new `TableColumn` object. */ - readonly range: Word.Range; + add(beforeColumn?: Word.TableColumn): Word.TableColumn; /** - * Returns the `ShadingUniversal` object that represents the shading of the table row. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + autoFit(): void; /** - * Gets the number of cells in the row. + * Deletes the specified columns. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellCount: number; + delete(): void; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Adjusts the width of the specified columns so that they are equal. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + distributeWidth(): void; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Selects the specified table columns. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isHeader: boolean; + select(): void; /** - * Specifies the preferred height of the row in points. + * Sets the width of columns in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width to set. + * @param rulerStyle - The ruler style to apply. */ - preferredHeight: number; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Gets the index of the row in its parent table. + * Sets the width of columns in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width to set. + * @param rulerStyle - The ruler style to apply. */ - readonly rowIndex: number; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. */ - shadingColor: string; + load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - values: string[][]; + load(propertyNames?: string | string[]): Word.TableColumnCollection; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection; /** - * 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. + * 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. */ - set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableRow): void; + track(): Word.TableColumnCollection; /** - * Clears the contents of the row. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - clear(): void; + untrack(): Word.TableColumnCollection; /** - * Converts the table row to text. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableColumnCollectionData; + } + /** + * Represents a table of authorities in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfAuthorities 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 portion of a document that is this table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. An object that specifies the options for converting the table row to text. */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; + readonly range: Word.Range; /** - * Deletes the entire row. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + bookmark: string; /** - * Gets the border style of the cells in the row. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation - Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + category: number; /** - * Gets the border style of the cells in the row. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation - Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + entrySeparator: string; /** - * Gets cell padding in points. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + isCategoryHeaderIncluded: boolean; /** - * Gets cell padding in points. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + isEntryFormattingKept: boolean; /** - * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNext(): Word.TableRow; + isPassimUsed: boolean; /** - * Gets the next row. If this row is the last one, 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}. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TableRow; + pageNumberSeparator: string; /** - * Inserts a content control on the row. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertContentControl(): Word.ContentControl; + pageRangeSeparator: string; /** - * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation - Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount - Required. Number of rows to add - * @param values - Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + sequenceName: string; /** - * Merges the row into one cell. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - merge(): Word.TableCell; + sequenceSeparator: string; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param searchText - Required. The search text. - * @param searchOptions - Optional. Options for the search. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Selects the row and navigates the Word UI to it. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * 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. */ - select(selectionMode?: Word.SelectionMode): void; + set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfAuthorities): void; /** - * Selects the row and navigates the Word UI to it. + * Deletes this table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: "Select" | "Start" | "End"): void; + delete(): void; /** - * Sets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @param options - Provides options for which properties of the object to load. */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; /** - * Sets cell padding in points. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.TableOfAuthorities; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @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. */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthorities; /** - * Sets the height of the row. + * 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.TableOfAuthorities; + /** + * 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.TableOfAuthorities; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfAuthoritiesData; + } + /** + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfAuthoritiesCollection 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.TableOfAuthorities[]; + /** + * Adds a table of authorities to the document at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param rowHeight - The height of the row, in points. - * @param heightRule - The rule for determining the height of the table row. + * @param range - The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. + * @param options - Optional. The options to configure the table of authorities. */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; /** - * Sets the height of the row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param rowHeight - The height of the row, in points. - * @param heightRule - The rule for determining the height of the table row. + * @param shortCitation - The citation text to mark. + * @param options - Optional. The options for marking the citation. */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; /** - * Sets the left indent for the table row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. - * @param rulerStyle - The ruler style to apply. + * @param range - The range where the citation will be inserted. + * @param shortCitation - The short citation text. + * @param options - Optional. The options for marking the citation. */ - setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; + markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; /** - * Sets the left indent for the table row. + * Finds and selects the next instance of the specified citation text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. - * @param rulerStyle - The ruler style to apply. + * @param shortCitation - The citation text to search for. */ - setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + selectNextCitation(shortCitation: string): 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.TableRowLoadOptions): Word.TableRow; + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; /** * 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.TableRow; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; /** * 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.TableRow; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; /** * 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.TableRow; + track(): Word.TableOfAuthoritiesCollection; /** * 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.TableRow; + untrack(): Word.TableOfAuthoritiesCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableRowData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; } /** - * Contains the collection of the document's TableRow objects. + * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableRowCollection 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.TableRow[]; + export interface TableOfAuthoritiesAddOptions { /** - * Converts rows in a table to text. + * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. + When specified, the entries are collected only from the portion of the document marked by the bookmark. + Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. An object that specifies the options for converting the table rows to text. - * @returns A `Range` object that represents the converted text. */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; + bookmark?: string; /** - * Deletes the table rows. + * If provided, specifies the category of entries to include in a table of authorities. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + category?: number; /** - * Adjusts the height of the rows so that they're equal. + * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, no separator is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distributeHeight(): void; + entrySeparator?: string; /** - * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). + Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableRow; + includeCategoryHeader?: boolean; /** - * Gets the first row 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}. + * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.TableRow; + keepEntryFormatting?: boolean; /** - * Selects the table rows. + * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. + Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a comma and a space (", ") are used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + pageNumberSeparator?: string; /** - * Sets the height of the cells in a table. + * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. + Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, an en dash ("–") is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + pageRangeSeparator?: string; + /** + * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. + Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * - * @param rowHeight - The height of the row, in points. - * @param heightRule - The rule for determining the height of the specified rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + sequenceName?: string; /** - * Sets the height of the cells in a table. + * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. + Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a hyphen ("-") is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + sequenceSeparator?: string; + /** + * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `false`. * - * @param rowHeight - The height of the row, in points. - * @param heightRule - The rule for determining the height of the specified rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + usePassim?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfAuthoritiesMarkCitationOptions { /** - * Sets the left indent for the table row. + * If provided, specifies the category number to be associated with the entry. + Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. + The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. + To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + category?: number; + /** + * If provided, specifies the long citation for the entry as it will appear in a table of authorities. * - * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. - * @param rulerStyle - The ruler style to apply. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; + longCitation?: string; /** - * Sets the left indent for the table row. + * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + longCitationAutoText?: string; + } + /** + * Represents a category used in a table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfAuthoritiesCategory 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; + /** + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * - * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. - * @param rulerStyle - The ruler style to apply. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + readonly name: string; /** * 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.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; /** * 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.TableRowCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; /** * 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.TableRowCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthoritiesCategory; /** * 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.TableRowCollection; + track(): Word.TableOfAuthoritiesCategory; /** * 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.TableRowCollection; + untrack(): Word.TableOfAuthoritiesCategory; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableRowCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; } /** - * Represents a table cell in a Word document. + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableCell extends OfficeExtension.ClientObject { + export class TableOfAuthoritiesCategoryCollection 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.TableOfAuthoritiesCategory[]; /** - * Gets the body object of the cell. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + getCount(): OfficeExtension.ClientResult; /** - * Returns the `TableColumn` object that represents the table column that contains this cell. + * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - The index of the item to retrieve. */ - readonly column: Word.TableColumn; + getItemAt(index: number): Word.TableOfAuthoritiesCategory; /** - * Gets the parent row of the cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. */ - readonly parentRow: Word.TableRow; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; /** - * Gets the parent table of the cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly parentTable: Word.Table; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; /** - * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly shading: Word.ShadingUniversal; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; /** - * Gets the index of the cell in its row. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - readonly cellIndex: number; + track(): Word.TableOfAuthoritiesCategoryCollection; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - columnWidth: number; + untrack(): Word.TableOfAuthoritiesCategoryCollection; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. - * - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; + } + /** + * Represents a table of contents in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfContents 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 index of the cell's row in the table. + * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + readonly range: Word.Range; /** - * Specifies the text of the cell. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value: string; + areBuiltInHeadingStylesUsed: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + areFieldsUsed: boolean; /** - * Gets the width of the cell in points. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] - */ - readonly 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableCell): void; + areHyperlinksUsedOnWeb: boolean; /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSum(): void; + arePageNumbersHiddenOnWeb: boolean; /** - * Deletes the table cell and optionally controls how the remaining cells are shifted. + * Specifies whether page numbers are included in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - delete(shiftCells: any): void; + arePageNumbersIncluded: boolean; /** - * Deletes the column containing this cell. This is applicable to uniform tables. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteColumn(): void; + arePageNumbersRightAligned: boolean; /** - * Deletes the row containing this cell. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteRow(): void; + lowerHeadingLevel: number; /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. An object that specifies the options for the formula. */ - formula(options?: Word.TableCellFormulaOptions): void; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the border style for the specified border. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation - Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + tableId: string; /** - * Gets the border style for the specified border. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation - Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + upperHeadingLevel: number; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * 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. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfContents): void; /** - * Gets cell padding in points. + * Deletes this table of contents. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + delete(): void; /** - * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * Updates the entire table of contents. * * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.TableCell; + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta /** - * Gets the next cell. If this cell is the last one, 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}. + * Updates only the page numbers for items in this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TableCell; + updatePageNumbers(): void; /** - * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param insertLocation - Required. It must be 'Before' or 'After'. - * @param columnCount - Required. Number of columns to add. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param options - Provides options for which properties of the object to load. */ - insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; /** - * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param insertLocation - Required. It must be 'Before' or 'After'. - * @param rowCount - Required. Number of rows to add. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + load(propertyNames?: string | string[]): Word.TableOfContents; /** - * Merges this table cell with the specified table cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param mergeTo - The cell to be merged with. + * @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. */ - merge(mergeTo: Word.TableCell): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; /** - * Selects the table cell. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - select(): void; + track(): Word.TableOfContents; /** - * Sets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * 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. */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + untrack(): Word.TableOfContents; /** - * Sets cell padding in points. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfContentsData; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfContentsCollection 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.TableOfContents[]; + /** + * Adds a table of contents to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @param range - The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. + * @param options - Optional. The options for configuring the table of contents. */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; /** - * Splits the cell into the specified number of rows and columns. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param rowCount - Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount - Required. The number of columns to split into. + * @param range - The range where the entry will be inserted. + * @param options - Optional. The options for marking the table of contents entry. */ - split(rowCount: number, columnCount: number): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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.TableCellLoadOptions): Word.TableCell; + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; /** * 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.TableCell; + load(propertyNames?: string | string[]): Word.TableOfContentsCollection; /** * 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.TableCell; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfContentsCollection; /** * 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.TableCell; + track(): Word.TableOfContentsCollection; /** * 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.TableCell; + untrack(): Word.TableOfContentsCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableCellData; + toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** - * Contains the collection of the document's TableCell objects. + * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableCellCollection 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.TableCell[]; + export interface TableOfContentsAddOptions { /** - * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * If provided, specifies the string names of additional styles to use for the table of contents. + Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit(): void; + addedStyles?: string; /** - * Deletes the table cells and optionally controls how the remaining cells are shifted. + * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - delete(shiftCells?: Word.DeleteCells): void; + hidePageNumbersOnWeb?: boolean; /** - * Deletes the table cells and optionally controls how the remaining cells are shifted. + * If provided, specifies whether to include page numbers in a table of contents. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; + includePageNumbers?: boolean; /** - * Adjusts the height of the specified cells so that they are equal. + * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distributeHeight(): void; + lowerHeadingLevel?: number; /** - * Adjusts the width of the specified cells so that they are equal. + * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distributeWidth(): void; - /** - * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.TableCell; - /** - * Gets the first table cell 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 1.3] - */ - getFirstOrNullObject(): Word.TableCell; + rightAlignPageNumbers?: boolean; /** - * Merges the specified cells into a single cell. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. + If this argument is omitted, TC fields aren't used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - merge(): void; + tableId?: string; /** - * Sets the height of the cells in a table. + * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight - The height of the row to set, in points. - * @param heightRule - The rule for determining the height of the specified rows. */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + upperHeadingLevel?: number; /** - * Sets the height of the cells in a table. + * If provided, specifies whether to use built-in heading styles to create a table of contents. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight - The height of the row to set, in points. - * @param heightRule - The rule for determining the height of the specified rows. */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + useBuiltInHeadingStyles?: boolean; /** - * Sets the width of the cells in a table. + * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. + Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param columnWidth - The width of the row to set, in points. - * @param rulerStyle - The ruler style to apply. */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + useFields?: boolean; /** - * Sets the width of the cells in a table. + * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param columnWidth - The width of the row to set, in points. - * @param rulerStyle - The ruler style to apply. */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + useHyperlinksOnWeb?: boolean; /** - * Splits this range of table cells. + * If provided, specifies whether to use outline levels to create a table of contents. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - TableCellCollectionSplitOptions. - */ - split(options?: Word.TableCellCollectionSplitOptions): 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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; - /** - * 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.TableCellCollection; - /** - * 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.TableCellCollection; - /** - * 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.TableCellCollection; - /** - * 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.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. */ - toJSON(): Word.Interfaces.TableCellCollectionData; + useOutlineLevels?: boolean; } /** - * Specifies the border style. + * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableBorder 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; + export interface TableOfContentsMarkEntryOptions { /** - * Specifies the table border color. + * If provided, specifies the text that appears in a table of contents or table of figures. + To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). + When the `entryAutoText` property is set, this property is ignored. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color: string; + entry?: string; /** - * Specifies the type of the table border. + * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. + When this property is used, the `entry` property is ignored. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + entryAutoText?: string; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.3] - */ - 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.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableBorder): 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.TableBorderLoadOptions): Word.TableBorder; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableBorder; + level?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). * - * @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.TableBorder; - /** - * 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.TableBorder; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TableBorderData; + tableId?: string; } /** - * Represents a document template. + * Represents a table of figures in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class Template extends OfficeExtension.ClientObject { + export class TableOfFigures 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; /** - * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + readonly range: Word.Range; /** - * Returns a `ListTemplateCollection` object that represents all the list templates in the template. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplates: Word.ListTemplateCollection; + areBuiltInHeadingStylesUsed: boolean; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + areFieldsUsed: boolean; /** - * Specifies the line break control level for the document. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + areHyperlinksUsedOnWeb: boolean; /** - * Returns the name of the template, including the drive or Web path. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fullName: string; + arePageNumbersHiddenOnWeb: boolean; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing: boolean; + arePageNumbersIncluded: boolean; /** - * Specifies the character spacing adjustment for the template. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + arePageNumbersRightAligned: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm: boolean; + captionLabel: string; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isLabelIncluded: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + lowerHeadingLevel: number; /** - * Returns only the name of the document template (excluding any path or other location information). + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter: string; + tableId: string; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore: string; + upperHeadingLevel: number; /** - * Returns the path to the document template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly path: string; + set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfFigures): void; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Deletes this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved: boolean; + delete(): void; /** - * Returns the template type. + * Updates the entire table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; - /** - * 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.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Template): void; /** - * Saves the template. + * Updates only the page numbers for items in this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - save(): void; + updatePageNumbers(): 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.TemplateLoadOptions): Word.Template; + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures; /** * 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.Template; + load(propertyNames?: string | string[]): Word.TableOfFigures; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18597,1127 +18899,992 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Template; + }): Word.TableOfFigures; /** * 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.Template; + track(): Word.TableOfFigures; /** * 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.Template; + untrack(): Word.TableOfFigures; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TemplateData; + toJSON(): Word.Interfaces.TableOfFiguresData; } /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class TemplateCollection extends OfficeExtension.ClientObject { + export class TableOfFiguresCollection 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.Template[]; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.TableOfFigures[]; /** - * Gets a `Template` object by its index in the collection. + * Adds a table of figures to the document at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index - The index of the template to retrieve. + * @param range - The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. + * @param options - Optional. The options for configuring the table of figures. */ - getItemAt(index: number): Word.Template; + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; /** - * Imports the building blocks for all templates into Microsoft Word. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range - The range where the TC field will be inserted. + * @param options - Optional. The options for marking the entry. */ - importBuildingBlocks(): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; /** * 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.TemplateCollection; + load(propertyNames?: string | string[]): Word.TableOfFiguresCollection; /** * 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.TemplateCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfFiguresCollection; /** * 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.TemplateCollection; + track(): Word.TableOfFiguresCollection; /** * 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.TemplateCollection; + untrack(): Word.TableOfFiguresCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TemplateCollectionData; + toJSON(): Word.Interfaces.TableOfFiguresCollectionData; } /** - * Represents a tracked change in a Word document. + * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TrackedChange 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; + export interface TableOfFiguresAddOptions { /** - * Gets the author of the tracked change. + * If provided, specifies the string names of additional styles to use for the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly author: string; + addedStyles?: string; /** - * Gets the date of the tracked change. + * If provided, specifies the label that identifies the items to include in a table of figures. + * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is "Figure". * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly date: Date; + captionLabel?: string; /** - * Gets the text of the tracked change. + * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * The default value is `true`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly text: string; + hidePageNumbersOnWeb?: boolean; /** - * Gets the type of the tracked change. + * If provided, specifies whether to include the caption label and caption number in a table of figures. + * The default value is `true`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + includeLabel?: boolean; /** - * Accepts the tracked change. + * If provided, specifies whether page numbers are included in a table of figures. + * The default value is `true`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accept(): void; + includePageNumbers?: boolean; /** - * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is `9`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNext(): Word.TrackedChange; + lowerHeadingLevel?: number; /** - * Gets the next tracked change. If this tracked change is the last one, 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}. + * If provided, specifies whether to align page numbers with the right margin in a table of figures. + * The default value is `true`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TrackedChange; + rightAlignPageNumbers?: boolean; /** - * Gets the range of the tracked change. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. + * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + tableId?: string; /** - * Rejects the tracked change. + * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is `1`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reject(): void; + upperHeadingLevel?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to use built-in heading styles to create a table of figures. + * The default value is `false`. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; + useBuiltInHeadingStyles?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. + * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. + * The default value is `false`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TrackedChange; + useFields?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. + * The default value is `true`. * - * @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.TrackedChange; - /** - * 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.TrackedChange; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TrackedChangeData; + useHyperlinksOnWeb?: boolean; } /** - * Contains a collection of {@link Word.TrackedChange} objects. + * Represents a row in a Word document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - export class TrackedChangeCollection extends OfficeExtension.ClientObject { + export class TableRow 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.TrackedChange[]; /** - * Accepts all the tracked changes in the collection. + * Gets cells. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - acceptAll(): void; + readonly cells: Word.TableCellCollection; /** - * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the collection of endnotes in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - getFirst(): Word.TrackedChange; + readonly endnotes: Word.NoteItemCollection; /** - * Gets the first TrackedChange 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}. + * Gets the collection of field objects in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - getFirstOrNullObject(): Word.TrackedChange; + readonly fields: Word.FieldCollection; /** - * Rejects all the tracked changes in the collection. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.6] - */ - rejectAll(): 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.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; - /** - * 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. + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TrackedChangeCollection; + readonly font: Word.Font; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of footnotes in the table row. * - * @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.TrackedChangeCollection; - /** - * 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.TrackedChangeCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi 1.5] */ - toJSON(): Word.Interfaces.TrackedChangeCollectionData; - } - /** - * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class View 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; + readonly footnotes: Word.NoteItemCollection; /** - * Gets the instance of a `RevisionsFilter` object. + * Gets parent table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly revisionsFilter: Word.RevisionsFilter; + readonly parentTable: Word.Table; /** - * Specifies whether all nonprinting characters are displayed. + * Returns the `Range` object that represents the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed: boolean; + readonly range: Word.Range; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed: boolean; + readonly shading: Word.ShadingUniversal; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areBookmarksIndicated: boolean; + readonly cellCount: number; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areCommentsDisplayed: boolean; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areConnectingLinesToRevisionsBalloonDisplayed: boolean; + readonly isHeader: boolean; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areCropMarksDisplayed: boolean; + preferredHeight: number; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areDrawingsDisplayed: boolean; + readonly rowIndex: number; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areEditableRangesShaded: boolean; + shadingColor: string; /** - * Specifies whether field codes are displayed. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areFieldCodesDisplayed: boolean; + values: string[][]; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areFormatChangesDisplayed: boolean; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies whether handwritten ink annotations are shown or hidden. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - areInkAnnotationsDisplayed: boolean; + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Clears the contents of the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areInsertionsAndDeletionsDisplayed: boolean; + clear(): void; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Converts the table row to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. An object that specifies the options for converting the table row to text. */ - readonly areLinesWrappedToWindow: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Deletes the entire row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areObjectAnchorsDisplayed: boolean; + delete(): void; /** - * Gets whether Microsoft Word displays optional line breaks. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - readonly areOptionalBreaksDisplayed: boolean; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Gets whether optional hyphens are displayed. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - readonly areOptionalHyphensDisplayed: boolean; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Gets whether other authors' presence should be visible in the document. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - areOtherAuthorsVisible: boolean; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - readonly arePageBoundariesDisplayed: boolean; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Gets whether paragraph marks are displayed. + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areParagraphsMarksDisplayed: boolean; + getNext(): Word.TableRow; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Gets the next row. If this row is the last one, 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 + * [Api set: WordApi 1.3] */ - readonly arePicturePlaceholdersDisplayed: boolean; + getNextOrNullObject(): Word.TableRow; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Inserts a content control on the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - areRevisionsAndCommentsDisplayed: boolean; + insertContentControl(): Word.ContentControl; /** - * Gets whether space characters are displayed. + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add + * @param values - Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ - readonly areSpacesIndicated: boolean; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Specifies whether table gridlines are displayed. + * Merges the row into one cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - areTableGridlinesDisplayed: boolean; + merge(): Word.TableCell; /** - * Gets whether tab characters are displayed. + * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly areTabsDisplayed: boolean; - /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. */ - readonly areTextBoundariesDisplayed: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies the column width in Reading mode. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; - /** - * Gets on-screen shading for fields. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + select(selectionMode?: Word.SelectionMode): void; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isDraft: boolean; - /** - * Specifies whether only the first line of body text is shown in outline view. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - isFirstLineOnlyDisplayed: boolean; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Specifies whether character formatting is visible in outline view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isFormatDisplayed: boolean; - /** - * Specifies whether the window is in full-screen view. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - isFullScreen: boolean; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Gets whether text formatted as hidden text is displayed. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isHiddenTextDisplayed: boolean; - /** - * Gets whether highlight formatting is displayed and printed with the document. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - readonly isHighlightingDisplayed: boolean; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Specifies whether the document is in conflict mode view. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - isInConflictMode: boolean; - /** - * Specifies whether Microsoft Word is in Panning mode. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the table row. */ - isInPanning: boolean; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Specifies whether the document is being viewed in reading layout view. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - isInReadingLayout: boolean; - /** - * Specifies whether mail merge data is displayed instead of mail merge fields. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the table row. */ - isMailMergeDataView: boolean; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - isMainTextLayerVisible: boolean; - /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - isPointerShownAsMagnifier: boolean; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - isReadingLayoutActualView: boolean; - /** - * Specifies whether XML tags are visible in the document. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - isXmlMarkupVisible: boolean; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Specifies the display mode for tracked changes. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; /** - * Specifies the page color in Reading mode. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; + load(propertyNames?: string | string[]): Word.TableRow; /** - * Specifies the page movement type. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableRow; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + track(): Word.TableRow; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; + untrack(): Word.TableRow; /** - * Specifies the width of the revision balloons. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - revisionsBalloonWidth: number; + toJSON(): Word.Interfaces.TableRowData; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableRowCollection 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.TableRow[]; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Converts rows in a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; - /** - * Specifies the document element displayed in print layout view. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Optional. An object that specifies the options for converting the table rows to text. + * @returns A `Range` object that represents the converted text. */ - seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies the active window pane. + * Deletes the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + delete(): void; /** - * Specifies the view type. + * Adjusts the height of the rows so that they're equal. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - /** - * 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.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.View): void; + distributeHeight(): void; /** - * Collapses all the headings in the document. + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - collapseAllHeadings(): void; + getFirst(): Word.TableRow; /** - * Collapses the text under the selection or the specified range by one heading level. + * Gets the first row 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 - * - * @param range - A `Range` object that specifies the range to collapse. + * [Api set: WordApi 1.3] */ - collapseOutline(range: Word.Range): void; + getFirstOrNullObject(): Word.TableRow; /** - * Expands all the headings in the document. + * Selects the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expandAllHeadings(): void; + select(): void; /** - * Expands the text under the selection by one heading level. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param range - A `Range` object that specifies the range to expand. + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - expandOutline(range: Word.Range): void; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - nextHeaderFooter(): void; - /** - * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - previousHeaderFooter(): void; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Switches between showing all text (headings and body text) and showing only headings. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - showAllHeadings(): void; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Shows all headings up to the specified heading level and hides subordinate headings and body text. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param level - The heading level to show. + * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - showHeading(level: number): void; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): 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.ViewLoadOptions): Word.View; + load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; /** * 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.View; + load(propertyNames?: string | string[]): Word.TableRowCollection; /** * 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.View; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection; /** * 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.View; + track(): Word.TableRowCollection; /** * 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.View; + 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.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ViewData; + toJSON(): Word.Interfaces.TableRowCollectionData; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a table cell in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - export class Shape extends OfficeExtension.ClientObject { + export class TableCell 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 text boxes and geometric shapes. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ readonly body: Word.Body; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly canvas: Word.Canvas; + readonly column: Word.TableColumn; /** - * Returns the fill formatting of the shape. + * Gets the parent row of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly fill: Word.ShapeFill; + readonly parentRow: Word.TableRow; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Gets the parent table of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly parentCanvas: Word.Shape; + readonly parentTable: Word.Table; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentGroup: Word.Shape; + readonly shading: Word.ShadingUniversal; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapeGroup: Word.ShapeGroup; + readonly cellIndex: number; /** - * Gets the text frame object of the shape. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textFrame: Word.TextFrame; + columnWidth: number; /** - * Returns the text wrap formatting of the shape. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textWrap: Word.ShapeTextWrap; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether a given shape can overlap other shapes. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - allowOverlap: boolean; + readonly rowIndex: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - altTextDescription: string; + shadingColor: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + value: string; /** - * The height, in points, of the shape. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height: number; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heightRelative: number; + readonly width: number; /** - * Gets an integer that represents the shape identifier. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. */ - readonly id: number; + set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isChild: boolean; + autoSum(): void; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Deletes the table cell and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - left: number; + delete(shiftCells: any): void; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Deletes the column containing this cell. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRelative: number; + deleteColumn(): void; /** - * Specifies if the aspect ratio of this shape is locked. + * Deletes the row containing this cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + deleteRow(): void; /** - * The name of the shape. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. An object that specifies the options for the formula. */ - name: string; + formula(options?: Word.TableCellFormulaOptions): void; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rotation: number; + getNext(): Word.TableCell; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets the next cell. If this cell is the last one, 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - top: number; + getNextOrNullObject(): Word.TableCell; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param columnCount - Required. Number of columns to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - topRelative: number; + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Merges this table cell with the specified table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param mergeTo - The cell to be merged with. */ - visible: boolean; + merge(mergeTo: Word.TableCell): void; /** - * The width, in points, of the shape. + * Selects the table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width: number; + select(): void; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Sets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - widthRelative: 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: WordApiDesktop 1.2] - */ - delete(): void; - /** - * Moves the shape horizontally by the number of points. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance - Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. - */ - moveHorizontally(distance: number): void; - /** - * Moves the shape vertically by the number of points. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance - Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. - */ - moveVertically(distance: number): void; - /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. - */ - scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; - /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. - */ - scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; - /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] * - * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Sets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] * - * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Selects the shape. + * Splits the cell into the specified number of rows and columns. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] * - * @param selectMultipleShapes - Optional. Whether to select multiple floating shapes. The default value is false. + * @param rowCount - Required. The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount - Required. The number of columns to split into. */ - select(selectMultipleShapes?: boolean): void; + split(rowCount: number, columnCount: number): 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; + load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; /** * 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; + load(propertyNames?: string | string[]): Word.TableCell; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -19726,151 +19893,234 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shape; + }): Word.TableCell; /** * 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; + track(): Word.TableCell; /** * 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; + 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.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. + * 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.ShapeData; + toJSON(): Word.Interfaces.TableCellData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Contains the collection of the document's TableCell objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - export class ShapeGroup extends OfficeExtension.ClientObject { + export class TableCellCollection 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.TableCell[]; /** - * Gets the Shape object associated with the group. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly shape: Word.Shape; + autoFit(): void; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly shapes: Word.ShapeCollection; + delete(shiftCells?: Word.DeleteCells): void; /** - * Gets an integer that represents the shape group identifier. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly id: number; + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; /** - * 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. + * Adjusts the height of the specified cells so that they are equal. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeGroup): void; + distributeHeight(): void; /** - * Ungroups any grouped shapes in the specified shape group. + * Adjusts the width of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ungroup(): Word.ShapeCollection; + distributeWidth(): void; + /** + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.TableCell; + /** + * Gets the first table cell 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 1.3] + */ + getFirstOrNullObject(): Word.TableCell; + /** + * Merges the specified cells into a single cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + merge(): void; + /** + * Sets the height of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight - The height of the row to set, in points. + * @param heightRule - The rule for determining the height of the specified rows. + */ + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + /** + * Sets the height of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight - The height of the row to set, in points. + * @param heightRule - The rule for determining the height of the specified rows. + */ + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + /** + * Sets the width of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width of the row to set, in points. + * @param rulerStyle - The ruler style to apply. + */ + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + /** + * Sets the width of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width of the row to set, in points. + * @param rulerStyle - The ruler style to apply. + */ + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + /** + * Splits this range of table cells. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - TableCellCollectionSplitOptions. + */ + split(options?: Word.TableCellCollectionSplitOptions): 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.ShapeGroupLoadOptions): Word.ShapeGroup; + load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; /** * 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.ShapeGroup; + load(propertyNames?: string | string[]): Word.TableCellCollection; /** * 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.ShapeGroup; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; /** * 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.ShapeGroup; + track(): Word.TableCellCollection; /** * 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.ShapeGroup; + 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.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ShapeGroupData; + toJSON(): Word.Interfaces.TableCellCollectionData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Specifies the border style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - export class Canvas extends OfficeExtension.ClientObject { + export class TableBorder 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 Shape object associated with the canvas. + * Specifies the table border color. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shape: Word.Shape; + color: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapes: Word.ShapeCollection; + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Gets an integer that represents the canvas identifier. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly id: number; + 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.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Canvas): void; + set(properties: Word.TableBorder): 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.CanvasLoadOptions): Word.Canvas; + load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; /** * 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.Canvas; + load(propertyNames?: string | string[]): Word.TableBorder; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -19879,212 +20129,195 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Canvas; + }): Word.TableBorder; /** * 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.Canvas; + track(): Word.TableBorder; /** * 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.Canvas; + 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.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + * 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.CanvasData; + toJSON(): Word.Interfaces.TableBorderData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a document template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class ShapeCollection extends OfficeExtension.ClientObject { + export class Template 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 the shapes that have the specified geometric types. Only applied to geometric shapes. + * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types - Required. An array of geometric shape subtypes. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; /** - * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id - Required. A shape identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getById(id: number): Word.Shape; + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; /** - * 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}. + * Returns a `ListTemplateCollection` object that represents all the list templates in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id - Required. A shape identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByIdOrNullObject(id: number): Word.Shape; + readonly listTemplates: Word.ListTemplateCollection; /** - * Gets the shapes by the identifiers. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param ids - Required. An array of shape identifiers. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByIds(ids: number[]): Word.ShapeCollection; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the shapes that have the specified names. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param names - Required. An array of shape names. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByNames(names: string[]): Word.ShapeCollection; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the shapes that have the specified types. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types - Required. An array of shape types. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + readonly fullName: string; /** - * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Shape; + hasNoProofing: boolean; /** - * 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}. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Shape; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - group(): Word.Shape; + kerningByAlgorithm: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `LanguageId` value that represents the language in the template. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies an East Asian language for the language in the template. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeCollection; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns only the name of the document template (excluding any path or other location information). * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeCollection; + readonly name: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeCollectionData; - } - /** - * Represents the fill formatting of a shape object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export class ShapeFill 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; + noLineBreakAfter: string; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor: string; + noLineBreakBefore: string; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns the path to the document template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor: string; + readonly path: string; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency: number; + saved: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Returns the template type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; /** * 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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeFill): void; - /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - clear(): void; + set(properties: Word.Template): void; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Saves the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param color - A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setSolidColor(color: string): void; + save(): 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.ShapeFillLoadOptions): Word.ShapeFill; + load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; /** * 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.ShapeFill; + load(propertyNames?: string | string[]): Word.Template; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -20093,275 +20326,177 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ShapeFill; + }): Word.Template; /** * 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.ShapeFill; + track(): Word.Template; /** * 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.ShapeFill; + untrack(): Word.Template; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeFillData; + toJSON(): Word.Interfaces.TemplateData; } /** - * Represents the text frame of a shape object. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TextFrame extends OfficeExtension.ClientObject { + export class TemplateCollection 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.Template[]; /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + getCount(): OfficeExtension.ClientResult; /** - * Represents the bottom margin, in points, of the text frame. + * Gets a `Template` object by its index in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the template to retrieve. */ - bottomMargin: number; - /** - * Specifies if the text frame contains text. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly hasText: boolean; - /** - * Represents the left margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - leftMargin: number; - /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - noTextRotation: boolean; - /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; - /** - * Represents the right margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - rightMargin: number; - /** - * Represents the top margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - topMargin: number; - /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + getItemAt(index: number): Word.Template; /** - * Determines whether lines break automatically to fit text inside the shape. + * Imports the building blocks for all templates into Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - wordWrap: boolean; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextFrame): void; + importBuildingBlocks(): 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.TextFrameLoadOptions): Word.TextFrame; + load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; /** * 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.TextFrame; + load(propertyNames?: string | string[]): Word.TemplateCollection; /** * 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.TextFrame; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; /** * 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.TextFrame; + track(): Word.TemplateCollection; /** * 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.TextFrame; + untrack(): Word.TemplateCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TextFrameData; + toJSON(): Word.Interfaces.TemplateCollectionData; } /** - * Represents all the properties for wrapping text around a shape. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - export class ShapeTextWrap extends OfficeExtension.ClientObject { + export class TrackedChange 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; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - bottomDistance: number; + readonly author: string; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - leftDistance: number; + readonly date: Date; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - rightDistance: number; + readonly text: string; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Accepts the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - topDistance: number; + accept(): void; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - /** - * 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.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeTextWrap): 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. + * [Api set: WordApi 1.6] */ - load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; + getNext(): Word.TrackedChange; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next tracked change. If this tracked change is the last one, 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}. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.6] */ - load(propertyNames?: string | string[]): Word.ShapeTextWrap; + getNextOrNullObject(): Word.TrackedChange; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the range of the tracked change. * - * @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.ShapeTextWrap; - /** - * 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.ShapeTextWrap; - /** - * 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.ShapeTextWrap; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.6] */ - toJSON(): Word.Interfaces.ShapeTextWrapData; - } - /** - * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Reviewer 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; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** - * Specifies if the `Reviewer` object is visible. + * Rejects the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isVisible: boolean; - /** - * 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. + * [Api set: WordApi 1.6] */ - set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Reviewer): void; + reject(): 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.ReviewerLoadOptions): Word.Reviewer; + load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; /** * 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.Reviewer; + load(propertyNames?: string | string[]): Word.TrackedChange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -20370,694 +20505,608 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Reviewer; + }): Word.TrackedChange; /** * 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.Reviewer; + track(): Word.TrackedChange; /** * 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.Reviewer; + 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.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ReviewerData; + toJSON(): Word.Interfaces.TrackedChangeData; } /** - * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - export class ReviewerCollection extends OfficeExtension.ClientObject { + export class TrackedChangeCollection 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.Reviewer[]; + readonly items: Word.TrackedChange[]; /** - * Returns a `Reviewer` object that represents the specified item in the collection. + * Accepts all the tracked changes in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + */ + acceptAll(): void; + /** + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. * - * @param index - The index of the item to retrieve. + * @remarks + * [Api set: WordApi 1.6] */ - getItem(index: number): Word.Reviewer; + getFirst(): Word.TrackedChange; + /** + * Gets the first TrackedChange 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 1.6] + */ + getFirstOrNullObject(): Word.TrackedChange; + /** + * Rejects all the tracked changes in the collection. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rejectAll(): 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.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; + load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + load(propertyNames?: string | string[]): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + track(): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + 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.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.ReviewerCollectionData; + toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class RevisionsFilter extends OfficeExtension.ClientObject { + export class View 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 `ReviewerCollection` object that represents the collection of reviewers of one or more documents. + * Gets the instance of a `RevisionsFilter` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly reviewers: Word.ReviewerCollection; + readonly revisionsFilter: Word.RevisionsFilter; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; + areAllNonprintingCharactersDisplayed: boolean; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view: Word.RevisionsView | "Final" | "Original"; - /** - * 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.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RevisionsFilter): void; + areBackgroundsDisplayed: boolean; /** - * Shows or hides all revisions in the document that contain comments and tracked changes. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggleShowAllReviewers(): void; + readonly areBookmarksIndicated: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays the comments in the document. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; + areCommentsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RevisionsFilter; + areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * - * @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.RevisionsFilter; - /** - * 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.RevisionsFilter; - /** - * 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.RevisionsFilter; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RevisionsFilterData; - } - /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RepeatingSectionItem 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; + readonly areCropMarksDisplayed: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; - /** - * 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.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionItem): void; + readonly areDrawingsDisplayed: boolean; /** - * Deletes this `RepeatingSectionItem` object. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + areEditableRangesShaded: boolean; /** - * Adds a repeating section item after this item and returns the new item. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertItemAfter(): Word.RepeatingSectionItem; + areFieldCodesDisplayed: boolean; /** - * Adds a repeating section item before this item and returns the new item. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertItemBefore(): Word.RepeatingSectionItem; + areFormatChangesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether handwritten ink annotations are shown or hidden. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; + areInkAnnotationsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItem; + areInsertionsAndDeletionsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * - * @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.RepeatingSectionItem; - /** - * 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.RepeatingSectionItem; - /** - * 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.RepeatingSectionItem; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RepeatingSectionItemData; - } - /** - * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RepeatingSectionItemCollection 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; + readonly areLinesWrappedToWindow: boolean; /** - * Returns an individual repeating section item. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The index of the item to retrieve. - * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - getItemAt(index: number): Word.RepeatingSectionItem; + readonly areObjectAnchorsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether Microsoft Word displays optional line breaks. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; + readonly areOptionalBreaksDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether optional hyphens are displayed. * - * @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.RepeatingSectionItemCollection; - /** - * 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.RepeatingSectionItemCollection; - /** - * 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.RepeatingSectionItemCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): { - [key: string]: string; - }; - } - /** - * Represents a single tracked change in a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Revision 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; + readonly areOptionalHyphensDisplayed: boolean; /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Gets whether other authors' presence should be visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly movedRange: Word.Range; + areOtherAuthorsVisible: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + readonly arePageBoundariesDisplayed: boolean; /** - * Gets the name of the user who made the tracked change. + * Gets whether paragraph marks are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly author: string; + readonly areParagraphsMarksDisplayed: boolean; /** - * Gets the date and time when the tracked change was made. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly date: Date; + readonly arePicturePlaceholdersDisplayed: boolean; /** - * Gets the description of tracked formatting changes in the revision. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly formatDescription: string; + areRevisionsAndCommentsDisplayed: boolean; /** - * Gets a number that represents the position of this item in a collection. + * Gets whether space characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly index: number; + readonly areSpacesIndicated: boolean; /** - * Gets the revision type. + * Specifies whether table gridlines are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; - /** - * 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.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Revision): void; + areTableGridlinesDisplayed: boolean; /** - * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. + * Gets whether tab characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accept(): void; + readonly areTabsDisplayed: boolean; /** - * Rejects the tracked change. The revision marks are removed, leaving the original text intact. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reject(): void; + readonly areTextBoundariesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the column width in Reading mode. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets on-screen shading for fields. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Revision; + readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * - * @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.Revision; - /** - * 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.Revision; - /** - * 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.Revision; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RevisionData; - } - /** - * A collection of Revision objects that represent the changes marked with revision marks in a range or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RevisionCollection 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.Revision[]; + isDraft: boolean; /** - * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - acceptAll(): void; + isFirstLineOnlyDisplayed: boolean; /** - * Returns a `Revision` object that represents the specified item in the collection. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The index of the item to retrieve. */ - getItem(index: number): Word.Revision; + isFormatDisplayed: boolean; /** - * Rejects all the tracked changes in the document or range. + * Specifies whether the window is in full-screen view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rejectAll(): void; + isFullScreen: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether text formatted as hidden text is displayed. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; + readonly isHiddenTextDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether highlight formatting is displayed and printed with the document. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RevisionCollection; + readonly isHighlightingDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the document is in conflict mode view. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; + isInConflictMode: boolean; /** - * 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. + * Specifies whether Microsoft Word is in Panning mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RevisionCollection; + isInPanning: boolean; /** - * 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. + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RevisionCollection; + isInReadingLayout: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Specifies whether mail merge data is displayed instead of mail merge fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RevisionCollectionData; - } - /** - * Represents the `DatePickerContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DatePickerContentControl 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; + isMailMergeDataView: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly placeholderText: Word.BuildingBlock; + isMainTextLayerVisible: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + isPointerShownAsMagnifier: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xmlMapping: Word.XmlMapping; + isReadingLayoutActualView: boolean; /** - * Specifies the appearance of the content control. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + isXmlMarkupVisible: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color: string; + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies the format in which dates are displayed. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat: string; + pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Gets the identification for the content control. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly id: string; + revisionsBalloonWidth: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary: boolean; + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl: boolean; + splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents: boolean; + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** - * Gets whether the placeholder text for the content control is being displayed. + * 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.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.View): void; + /** + * Collapses all the headings in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly showingPlaceholderText: boolean; + collapseAllHeadings(): void; /** - * Specifies a tag to identify the content control. + * Collapses the text under the selection or the specified range by one heading level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range - A `Range` object that specifies the range to collapse. */ - tag: string; + collapseOutline(range: Word.Range): void; /** - * Specifies the title for the content control. + * Expands all the headings in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title: string; + expandAllHeadings(): void; /** - * 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. + * Expands the text under the selection by one heading level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - A `Range` object that specifies the range to expand. */ - set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DatePickerContentControl): void; + expandOutline(range: Word.Range): void; /** - * Copies the content control from the active document to the Clipboard. + * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + nextHeaderFooter(): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + previousHeaderFooter(): void; /** - * Deletes this content control and the contents of the content control. + * Switches between showing all text (headings and body text) and showing only headings. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param deleteContents - Optional. If true, deletes the contents as well. */ - delete(deleteContents?: boolean): void; + showAllHeadings(): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Shows all headings up to the specified heading level and hides subordinate headings and body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options - Optional. The options for configuring the content control's placeholder text. + * @param level - The heading level to show. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + showHeading(level: number): 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.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; + load(options?: Word.Interfaces.ViewLoadOptions): Word.View; /** * 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.DatePickerContentControl; + load(propertyNames?: string | string[]): Word.View; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -21066,392 +21115,338 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DatePickerContentControl; + }): Word.View; /** * 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.DatePickerContentControl; + track(): Word.View; /** * 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.DatePickerContentControl; + untrack(): Word.View; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DatePickerContentControlData; + toJSON(): Word.Interfaces.ViewData; } /** - * Represents the `PictureContentControl` object. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class PictureContentControl extends OfficeExtension.ClientObject { + 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + readonly body: Word.Body; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly canvas: Word.Canvas; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly fill: Word.ShapeFill; /** - * Specifies the appearance of the content control. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + readonly parentCanvas: Word.Shape; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + readonly parentGroup: Word.Shape; /** - * Returns the identification for the content control. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + readonly shapeGroup: Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + readonly textFrame: Word.TextFrame; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + readonly textWrap: Word.ShapeTextWrap; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + allowOverlap: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + altTextDescription: string; /** - * Returns whether the placeholder text for the content control is being displayed. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies a tag to identify the content control. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + height: number; /** - * Specifies the title for the content control. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - title: string; - /** - * 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. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PictureContentControl): void; + heightRelative: number; /** - * Copies the content control from the active document to the Clipboard. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + readonly id: number; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + readonly isChild: boolean; /** - * Deletes the content control and optionally its contents. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Decides whether to delete the contents of the content control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents?: boolean): void; + left: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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. + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + leftRelative: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies if the aspect ratio of this shape is locked. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.PictureContentControl; + lockAspectRatio: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * The name of the shape. * - * @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.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.PictureContentControlData; - } - /** - * Represents the `GroupContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class GroupContentControl 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; + name: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the appearance of the content control. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + rotation: number; /** - * Returns the identification for the content control. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + top: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + topRelative: number; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + visible: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + width: number; /** - * Returns whether the placeholder text for the content control is being displayed. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + widthRelative: number; /** - * Specifies a tag to identify the content control. + * 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 + * [Api set: WordApiDesktop 1.2] */ - tag: string; + delete(): void; /** - * Specifies the title for the content control. + * Moves the shape horizontally by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance - Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ - title: string; + moveHorizontally(distance: number): void; /** - * 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. + * Moves the shape vertically by the number of points. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param distance - Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ - set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GroupContentControl): void; + moveVertically(distance: number): void; /** - * Copies the content control from the active document to the Clipboard. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - copy(): void; + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - cut(): void; + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Deletes the content control and optionally its contents. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param deleteContents - Optional. Whether to delete the contents inside the control. + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - delete(deleteContents: boolean): void; + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param options - Optional. The options for configuring the content control's placeholder text. + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * Selects the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param selectMultipleShapes - Optional. Whether to select multiple floating shapes. The default value is false. */ - ungroup(): void; + 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.GroupContentControlLoadOptions): Word.GroupContentControl; + 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.GroupContentControl; + 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. * @@ -21460,240 +21455,151 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.GroupContentControl; + }): 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.GroupContentControl; + 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.GroupContentControl; + 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.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.GroupContentControlData; - } - /** - * The options that define what placeholder to be used in the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ContentControlPlaceholderOptions { - /** - * If provided, specifies the `BuildingBlock` object to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - buildingBlock?: Word.BuildingBlock; - /** - * If provided, specifies the `Range` object to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Range; - /** - * If provided, specifies the text to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - text?: string; + toJSON(): Word.Interfaces.ShapeData; } /** - * Represents the `BuildingBlockGalleryContentControl` object. + * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class BuildingBlockGalleryContentControl extends OfficeExtension.ClientObject { + export class ShapeGroup 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly placeholderText: Word.BuildingBlock; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly shape: Word.Shape; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly shapes: Word.ShapeCollection; /** - * Specifies the appearance of the content control. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + readonly id: number; /** - * Specifies the category for the building block content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - buildingBlockCategory: string; + set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeGroup): void; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Ungroups any grouped shapes in the specified shape group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + ungroup(): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - color: string; + load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; /** - * Gets the identification for the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly id: string; + load(propertyNames?: string | string[]): Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isTemporary: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeGroup; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + track(): Word.ShapeGroup; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lockContentControl: boolean; + untrack(): Word.ShapeGroup; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. */ - lockContents: boolean; + toJSON(): Word.Interfaces.ShapeGroupData; + } + /** + * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class Canvas 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 if the placeholder text for the content control is being displayed. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + readonly shape: Word.Shape; /** - * Specifies a tag to identify the content control. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + readonly shapes: Word.ShapeCollection; /** - * Specifies the title for the content control. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly id: 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.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.BuildingBlockGalleryContentControl): void; - /** - * Copies the content control from the active document to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; - /** - * Deletes the content control and optionally its contents. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Whether to delete the contents inside the control. - */ - delete(deleteContents?: boolean): void; - /** - * Sets the placeholder text that displays in the content control until a user enters their own text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + set(properties: Word.Canvas): 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.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; + load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + load(propertyNames?: string | string[]): Word.Canvas; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -21702,215 +21608,212 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.BuildingBlockGalleryContentControl; + }): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + track(): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + untrack(): Word.Canvas; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + toJSON(): Word.Interfaces.CanvasData; } /** - * Represents the `RepeatingSectionContentControl` object. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + 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[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types - Required. An array of geometric shape subtypes. */ - readonly placeholderText: Word.BuildingBlock; + getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * 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 + * [Api set: WordApiDesktop 1.2] + * + * @param id - Required. A shape identifier. */ - readonly range: Word.Range; + getById(id: number): Word.Shape; /** - * Returns the collection of repeating section items in this repeating section content control. + * 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 + * [Api set: WordApiDesktop 1.2] + * + * @param id - Required. A shape identifier. */ - readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; + getByIdOrNullObject(id: number): Word.Shape; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the shapes by the identifiers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param ids - Required. An array of shape identifiers. */ - readonly xmlapping: Word.XmlMapping; + getByIds(ids: number[]): Word.ShapeCollection; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Gets the shapes that have the specified names. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param names - Required. An array of shape names. */ - allowInsertDeleteSection: boolean; + getByNames(names: string[]): Word.ShapeCollection; /** - * Specifies the appearance of the content control. + * Gets the shapes that have the specified types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types - Required. An array of shape types. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + getFirst(): Word.Shape; /** - * Returns the identification for the content control. + * 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 + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + getFirstOrNullObject(): Word.Shape; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + group(): Word.Shape; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - lockContentControl: boolean; + load(propertyNames?: string | string[]): Word.ShapeCollection; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContents: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * 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; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class ShapeFill 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; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - repeatingSectionItemTitle: string; + backgroundColor: string; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + foregroundColor: string; /** - * Specifies a tag to identify the content control. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + transparency: number; /** - * Specifies the title for the content control. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; /** * 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.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionContentControl): void; + set(properties: Word.ShapeFill): void; /** - * Copies the content control from the active document to the Clipboard. + * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + clear(): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param color - A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. */ - cut(): void; + setSolidColor(color: string): void; /** - * Deletes the content control and the contents of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Whether to delete the contents inside the control. - */ - delete(deleteContents?: boolean): void; - /** - * Sets the placeholder text that displays in the content control until a user enters their own text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + load(propertyNames?: string | string[]): Word.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -21919,319 +21822,275 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RepeatingSectionContentControl; + }): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + track(): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + untrack(): Word.ShapeFill; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + toJSON(): Word.Interfaces.ShapeFillData; } /** - * Calendar types. + * Represents the text frame of a shape object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum CalendarType { + export class TextFrame 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; /** - * Western calendar type. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - western = "Western", + autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Arabic calendar type. + * Represents the bottom margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabic = "Arabic", + bottomMargin: number; /** - * Hebrew calendar type. + * Specifies if the text frame contains text. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hebrew = "Hebrew", + readonly hasText: boolean; /** - * Taiwan calendar type. + * Represents the left margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - taiwan = "Taiwan", + leftMargin: number; /** - * Japanese calendar type. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - japan = "Japan", + noTextRotation: boolean; /** - * Thai calendar type. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thai = "Thai", + orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Korean calendar type. + * Represents the right margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - korean = "Korean", + rightMargin: number; /** - * Saka Era calendar type. + * Represents the top margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sakaEra = "SakaEra", + topMargin: number; /** - * Transliterated English calendar type. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - translitEnglish = "TranslitEnglish", + verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Transliterated French calendar type. + * Determines whether lines break automatically to fit text inside the shape. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - translitFrench = "TranslitFrench", + wordWrap: boolean; /** - * Umm al-Qura calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - umalqura = "Umalqura", - } - /** - * Date storage formats for {@link Word.DatePickerContentControl}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlDateStorageFormat { + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextFrame): void; /** - * Stores the date as text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - text = "Text", + load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; /** - * Stores the date as a date object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - date = "Date", + load(propertyNames?: string | string[]): Word.TextFrame; /** - * Stores the date as a date-time object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dateTime = "DateTime", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextFrame; + /** + * 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.TextFrame; + /** + * 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.TextFrame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextFrameData; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents all the properties for wrapping text around a shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class Frame extends OfficeExtension.ClientObject { + export class ShapeTextWrap 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; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly borders: Word.BorderUniversalCollection; - /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + bottomDistance: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly shading: Word.ShadingUniversal; + leftDistance: number; /** - * Specifies the height (in points) of the frame. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - height: number; + rightDistance: number; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalDistanceFromText: number; + topDistance: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalPosition: number; + type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; /** - * Specifies if the frame is locked. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lockAnchor: boolean; + set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeTextWrap): void; /** - * Specifies the relative horizontal position of the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; /** - * Specifies the relative vertical position of the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNames?: string | string[]): Word.ShapeTextWrap; /** - * Specifies if document text wraps around the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - textWrap: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeTextWrap; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - verticalDistanceFromText: number; + track(): Word.ShapeTextWrap; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - verticalPosition: number; + untrack(): Word.ShapeTextWrap; /** - * Specifies the width (in points) of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. */ - width: number; + toJSON(): Word.Interfaces.ShapeTextWrapData; + } + /** + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Reviewer 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; /** - * Specifies the rule used to determine the width of the frame. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + isVisible: boolean; /** * 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.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Frame): void; - /** - * Copies the frame to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the frame from the document and places it on the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; - /** - * Deletes the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - delete(): void; - /** - * Selects the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - select(): void; + set(properties: Word.Reviewer): 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.FrameLoadOptions): Word.Frame; + load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; /** * 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.Frame; + load(propertyNames?: string | string[]): Word.Reviewer; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -22240,140 +22099,137 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Frame; + }): Word.Reviewer; /** * 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.Frame; + track(): Word.Reviewer; /** * 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.Frame; + untrack(): Word.Reviewer; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.FrameData; + toJSON(): Word.Interfaces.ReviewerData; } /** - * Represents the collection of {@link Word.Frame} objects. + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class FrameCollection extends OfficeExtension.ClientObject { + export class ReviewerCollection 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.Frame[]; - /** - * Returns a `Frame` object that represents a new frame added to a range, selection, or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param range - The range where the frame will be added. - * @returns A `Frame` object that represents the new frame. - */ - add(range: Word.Range): Word.Frame; - /** - * Deletes the `FrameCollection` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - delete(): void; + readonly items: Word.Reviewer[]; /** - * Gets a `Frame` object by its index in the collection. + * Returns a `Reviewer` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index - The location of a `Frame` object. + * @param index - The index of the item to retrieve. */ - getItem(index: number): Word.Frame; + getItem(index: number): Word.Reviewer; /** * 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.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; /** * 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.FrameCollection; + load(propertyNames?: string | string[]): Word.ReviewerCollection; /** * 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.FrameCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; /** * 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.FrameCollection; + track(): Word.ReviewerCollection; /** * 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.FrameCollection; + untrack(): Word.ReviewerCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.FrameCollectionData; + toJSON(): Word.Interfaces.ReviewerCollectionData; } /** - * Represents a document library version. + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class DocumentLibraryVersion extends OfficeExtension.ClientObject { + export class RevisionsFilter 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 any optional comments associated with this version of the shared document. + * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: string; + readonly reviewers: Word.ReviewerCollection; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modified: any; + markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modifiedBy: string; + view: Word.RevisionsView | "Final" | "Original"; + /** + * 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.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RevisionsFilter): void; + /** + * Shows or hides all revisions in the document that contain comments and tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleShowAllReviewers(): 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.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; /** * 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.DocumentLibraryVersion; + load(propertyNames?: string | string[]): Word.RevisionsFilter; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -22382,15136 +22238,15616 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DocumentLibraryVersion; + }): Word.RevisionsFilter; /** * 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.DocumentLibraryVersion; + track(): Word.RevisionsFilter; /** * 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.DocumentLibraryVersion; + untrack(): Word.RevisionsFilter; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DocumentLibraryVersionData; + toJSON(): Word.Interfaces.RevisionsFilterData; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class DocumentLibraryVersionCollection extends OfficeExtension.ClientObject { + export class RepeatingSectionItem 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.DocumentLibraryVersion[]; /** - * Gets a `DocumentLibraryVersion` object by its index in the collection. + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * 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.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionItem): void; + /** + * Deletes this `RepeatingSectionItem` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + delete(): void; + /** + * Adds a repeating section item after this item and returns the new item. * - * @param index - The location of a `DocumentLibraryVersion` object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(index: number): Word.DocumentLibraryVersion; + insertItemAfter(): Word.RepeatingSectionItem; /** - * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * Adds a repeating section item before this item and returns the new item. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVersioningEnabled(): OfficeExtension.ClientResult; + insertItemBefore(): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollection; + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollection; + track(): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollection; + untrack(): Word.RepeatingSectionItem; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; - } - /** - * Represents the possible change tracking modes. - * - * @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] + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. */ - deleted = "Deleted", + toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** - * TrackedChange type. + * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum TrackedChangeType { + export class RepeatingSectionItemCollection 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; /** - * No revision. + * Returns an individual repeating section item. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the item to retrieve. + * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - none = "None", + getItemAt(index: number): Word.RepeatingSectionItem; /** - * Add 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 propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - added = "Added", + load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; /** - * Delete 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 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. */ - deleted = "Deleted", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItemCollection; /** - * Format change. - * @remarks - * [Api set: WordApi 1.6] + * 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. */ - formatted = "Formatted", - } - /** - * Note item type - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + track(): Word.RepeatingSectionItemCollection; /** - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - footnote = "Footnote", + untrack(): Word.RepeatingSectionItemCollection; /** - * @remarks - * [Api set: WordApi 1.5] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - endnote = "Endnote", + toJSON(): { + [key: string]: string; + }; } /** - * Provides information about the type of a raised event. + * Represents a single tracked change in a document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum EventType { - /** - * ContentControlDeleted represents the event that the content control has been deleted. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlDeleted = "ContentControlDeleted", - /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlSelectionChanged = "ContentControlSelectionChanged", - /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlDataChanged = "ContentControlDataChanged", + export class Revision 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; /** - * ContentControlAdded represents the event a content control has been added to the document. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlAdded = "ContentControlAdded", + readonly movedRange: Word.Range; /** - * Represents that one or more comments were deleted. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeleted = "CommentDeleted", + readonly range: Word.Range; /** - * Represents that a comment was selected. + * Gets the name of the user who made the tracked change. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentSelected = "CommentSelected", + readonly author: string; /** - * Represents that a comment was deselected. + * Gets the date and time when the tracked change was made. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeselected = "CommentDeselected", + readonly date: Date; /** - * Represents that a comment or its reply was changed. + * Gets the description of tracked formatting changes in the revision. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentChanged = "CommentChanged", + readonly formatDescription: string; /** - * Represents that one or more new comments were added. + * Gets a number that represents the position of this item in a collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentAdded = "CommentAdded", + readonly index: number; /** - * Represents that a content control has been entered. + * Gets the revision type. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlEntered = "ContentControlEntered", + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** - * Represents that a content control has been exited. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - contentControlExited = "ContentControlExited", + set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Revision): void; /** - * Represents that one or more new paragraphs were added. + * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphAdded = "ParagraphAdded", + accept(): void; /** - * Represents that one or more paragraphs were changed. + * Rejects the tracked change. The revision marks are removed, leaving the original text intact. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphChanged = "ParagraphChanged", + reject(): void; /** - * Represents that one or more paragraphs were deleted. - * @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. */ - paragraphDeleted = "ParagraphDeleted", + load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationClicked = "AnnotationClicked", + load(propertyNames?: string | string[]): Word.Revision; /** - * Represents that an annotation was hovered over in the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationHovered = "AnnotationHovered", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; /** - * Represents that one or more annotations were added in the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationInserted = "AnnotationInserted", + track(): Word.Revision; /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationRemoved = "AnnotationRemoved", + untrack(): Word.Revision; /** - * Represents an action in the annotation pop-up. - * @remarks - * [Api set: WordApi 1.8] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. */ - annotationPopupAction = "AnnotationPopupAction", + toJSON(): Word.Interfaces.RevisionData; } /** - * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum EventSource { + export class RevisionCollection 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.Revision[]; /** + * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - local = "Local", + acceptAll(): void; /** + * Returns a `Revision` object that represents the specified item in the collection. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the item to retrieve. */ - remote = "Remote", - } - /** - * Provides information about the content control that raised contentControlAdded event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlAddedEventArgs { + getItem(index: number): Word.Revision; /** - * The event type. See Word.EventType for details. + * Rejects all the tracked changes in the document or range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + rejectAll(): void; /** - * Gets the content control IDs. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param options - Provides options for which properties of the object to load. */ - ids: number[]; + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; /** - * The source of the event. It can be local or remote (through coauthoring). + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDataChanged event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlDataChangedEventArgs { + load(propertyNames?: string | string[]): Word.RevisionCollection; /** - * The event type. See Word.EventType for details. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @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. */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; /** - * Gets the content control IDs. - * - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - ids: number[]; + track(): Word.RevisionCollection; /** - * The source of the event. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - source: Word.EventSource | "Local" | "Remote"; + untrack(): Word.RevisionCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RevisionCollectionData; } /** - * Provides information about the content control that raised contentControlDeleted event. + * Represents the `DatePickerContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ContentControlDeletedEventArgs { + export class DatePickerContentControl 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; /** - * The event type. See Word.EventType for details. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly placeholderText: Word.BuildingBlock; /** - * Gets the content control IDs. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly range: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlEntered event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlEnteredEventArgs { + readonly xmlMapping: Word.XmlMapping; /** - * The event type. See Word.EventType for details. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the content control IDs. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + color: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlExited event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlExitedEventArgs { + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * The event type. See Word.EventType for details. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + dateDisplayFormat: string; /** - * Gets the content control IDs. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Represents a dropped capital letter in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DropCap 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; + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly distanceFromText: number; + readonly id: string; /** - * Gets the name of the font for the dropped capital letter. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fontName: string; + isTemporary: boolean; /** - * Gets the height (in lines) of the dropped capital letter. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly linesToDrop: number; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the position of the dropped capital letter. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; + lockContentControl: boolean; /** - * Removes the dropped capital letter formatting. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clear(): void; + lockContents: boolean; /** - * Formats the first character in the specified paragraph as a dropped capital letter. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enable(): void; + readonly showingPlaceholderText: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a tag to identify the content control. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; + tag: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the title for the content control. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DropCap; + title: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DatePickerContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copy(): void; + /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; + /** + * Deletes this content control and the contents of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents - Optional. If true, deletes the contents as well. + */ + delete(deleteContents?: boolean): void; + /** + * Sets the placeholder text that displays in the content control until a user enters their own text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. + */ + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; + /** + * 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.DatePickerContentControl; + /** + * 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.DropCap; + }): Word.DatePickerContentControl; /** * 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.DropCap; + track(): Word.DatePickerContentControl; /** * 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.DropCap; + untrack(): Word.DatePickerContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DropCapData; + toJSON(): Word.Interfaces.DatePickerContentControlData; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ContentControlSelectionChangedEventArgs { + export class PictureContentControl 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; /** - * The event type. See Word.EventType for details. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly placeholderText: Word.BuildingBlock; /** - * Gets the content control IDs. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly range: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the paragraphs that raised the paragraphAdded event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ParagraphAddedEventArgs { + readonly xmlMapping: Word.XmlMapping; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The event type. See Word.EventType for details. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + color: string; /** - * 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. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphChanged event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ParagraphChangedEventArgs { + readonly id: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + isTemporary: boolean; /** - * The event type. See Word.EventType for details. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * 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. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphDeleted event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ParagraphDeletedEventArgs { + lockContentControl: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + lockContents: boolean; /** - * The event type. See Word.EventType for details. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + readonly showingPlaceholderText: boolean; /** - * 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. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the comments that raised the comment event. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CommentEventArgs { + tag: string; /** - * Represents how the comment changed event is triggered. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; + title: string; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * 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.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PictureContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDetails: Word.CommentDetail[]; + copy(): void; /** - * The source of the event. It can be local or remote (through coauthoring). + * Removes the content control from the active document and moves the content control to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - source: Word.EventSource | "Local" | "Remote"; + cut(): void; /** - * The event type. See Word.EventType for details. + * Deletes the content control and optionally its contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents - Optional. Decides whether to delete the contents of the content control. */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; - } - /** - * A structure for the ID and reply IDs of this comment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CommentDetail { + delete(deleteContents?: boolean): void; /** - * Represents the ID of this comment. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - id: string; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents the IDs of the replies to this comment. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - replyIds: string[]; + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PictureContentControlData; } /** - * Represents how the comments in the event were changed. + * Represents the `GroupContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CommentChangeType { + export class GroupContentControl 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; /** - * No comment changed event is triggered. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + readonly placeholderText: Word.BuildingBlock; /** - * A comment was edited. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edited = "edited", + readonly range: Word.Range; /** - * A comment was resolved. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resolved = "resolved", + readonly xmlMapping: Word.XmlMapping; /** - * A comment was reopened. + * Specifies the appearance of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reopened = "reopened", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * A reply was added. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyAdded = "replyAdded", + color: string; /** - * A reply was deleted. + * Returns the identification for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyDeleted = "replyDeleted", + readonly id: string; /** - * A reply was edited. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyEdited = "replyEdited", - } - /** - * Specifies supported content control types and subtypes. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum ContentControlType { + isTemporary: boolean; /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextInline = "RichTextInline", + lockContentControl: boolean; /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextParagraphs = "RichTextParagraphs", + lockContents: boolean; /** - * Contains a whole cell. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTableCell = "RichTextTableCell", + readonly showingPlaceholderText: boolean; /** - * Contains a whole row. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTableRow = "RichTextTableRow", + tag: string; /** - * Contains a whole table. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTable = "RichTextTable", + title: string; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - plainTextInline = "PlainTextInline", + set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GroupContentControl): void; /** + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainTextParagraph = "PlainTextParagraph", + copy(): void; /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + cut(): void; /** + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - buildingBlockGallery = "BuildingBlockGallery", + delete(deleteContents: boolean): void; /** + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - checkBox = "CheckBox", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** + * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBox = "ComboBox", + ungroup(): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dropDownList = "DropDownList", + load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - datePicker = "DatePicker", + load(propertyNames?: string | string[]): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - repeatingSection = "RepeatingSection", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GroupContentControl; /** - * Identifies a rich text content control. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richText = "RichText", + track(): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - plainText = "PlainText", + untrack(): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - group = "Group", + toJSON(): Word.Interfaces.GroupContentControlData; } /** - * ContentControl appearance. + * The options that define what placeholder to be used in the content control. * * @remarks - * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ContentControlAppearance { + export interface ContentControlPlaceholderOptions { /** - * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * If provided, specifies the `BuildingBlock` object to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boundingBox = "BoundingBox", + buildingBlock?: Word.BuildingBlock; /** - * Represents a content control shown as start and end markers. + * If provided, specifies the `Range` object to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tags = "Tags", + range?: Word.Range; /** - * Represents a content control that isn't shown. + * If provided, specifies the text to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", + text?: string; } /** - * Content control level types. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ContentControlLevel { + export class BuildingBlockGalleryContentControl 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 an inline content control. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + readonly placeholderText: Word.BuildingBlock; /** - * Represents a paragraph-level content control. + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + readonly range: Word.Range; /** - * Represents a row-level content control. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + readonly xmlMapping: Word.XmlMapping; /** - * Represents a cell-level content control. + * Specifies the appearance of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cell = "Cell", - } - /** - * Represents the state of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlState { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Error state. + * Specifies the category for the building block content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - error = "Error", + buildingBlockCategory: string; /** - * Warning state. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warning = "Warning", - } - /** - * The supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { - /** - * @remarks - * [Api set: WordApi 1.1] - */ - mixed = "Mixed", + buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * No underline. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + color: string; /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", + readonly id: string; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotLine = "DotLine", + isTemporary: boolean; /** - * A single underline. This is the default value. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - single = "Single", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Only underline individual words. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - word = "Word", + lockContentControl: boolean; /** - * A double underline. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - double = "Double", + lockContents: boolean; /** - * A single thick underline. + * Gets if the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thick = "Thick", + readonly showingPlaceholderText: boolean; /** - * A dotted underline. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + tag: string; /** + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dottedHeavy = "DottedHeavy", + title: string; /** - * A single dash underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dashLine = "DashLine", + set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BuildingBlockGalleryContentControl): void; /** + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineHeavy = "DashLineHeavy", + copy(): void; /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLong = "DashLineLong", + cut(): void; /** + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - dashLineLongHeavy = "DashLineLongHeavy", + delete(deleteContents?: boolean): void; /** - * An alternating dot-dash underline. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - The options for configuring the content control's placeholder text. */ - dotDashLine = "DotDashLine", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dotDashLineHeavy = "DotDashLineHeavy", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; /** - * An alternating dot-dot-dash underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - twoDotDashLine = "TwoDotDashLine", + load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; /** - * A single wavy underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - wave = "Wave", + track(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - waveHeavy = "WaveHeavy", + untrack(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - waveDouble = "WaveDouble", + toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; } /** - * Specifies the form of a break. + * Represents the `RepeatingSectionContentControl` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BreakType { + export class RepeatingSectionContentControl 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; /** - * Page break at the insertion point. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - page = "Page", + readonly placeholderText: Word.BuildingBlock; /** - * Warning: next has been deprecated. Use sectionNext instead. - * @deprecated Use sectionNext instead. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - next = "Next", + readonly range: Word.Range; /** - * Section break on next page. + * Returns the collection of repeating section items in this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionNext = "SectionNext", + readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; /** - * New section without a corresponding page break. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionContinuous = "SectionContinuous", + readonly xmlapping: Word.XmlMapping; /** - * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionEven = "SectionEven", + allowInsertDeleteSection: boolean; /** - * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionOdd = "SectionOdd", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Line break. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - line = "Line", - } - /** - * The insertion location types. - * - * @remarks - * [Api set: WordApi 1.1] - * - * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. - */ - enum InsertLocation { + color: string; /** - * Add content before the contents of the calling object. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + readonly id: string; /** - * Add content after the contents of the calling object. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", + isTemporary: boolean; /** - * Prepend content to the contents of the calling object. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Append content to the contents of the calling object. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + lockContentControl: boolean; /** - * Replace the contents of the current object. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replace = "Replace", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum Alignment { + lockContents: boolean; /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + repeatingSectionItemTitle: string; /** - * Unknown alignment. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly showingPlaceholderText: boolean; /** - * Alignment to the left. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + tag: string; /** - * Alignment to the center. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - centered = "Centered", + title: string; /** - * Alignment to the right. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - right = "Right", + set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionContentControl): void; /** - * Fully justified alignment. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - justified = "Justified", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum HeaderFooterType { + copy(): void; /** - * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - primary = "Primary", + cut(): void; /** - * Returns the header or footer on the first page of a section. + * Deletes the content control and the contents of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - firstPage = "FirstPage", + delete(deleteContents?: boolean): void; /** - * Returns all headers or footers on even-numbered pages of a section. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - evenPages = "EvenPages", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RepeatingSectionContentControlData; } /** - * Represents the types of body objects. + * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BodyType { - /** - * Unknown body type. - * @remarks - * [Api set: WordApi 1.3] - */ - unknown = "Unknown", - /** - * Main document body. - * @remarks - * [Api set: WordApi 1.3] - */ - mainDoc = "MainDoc", + export class ReadabilityStatistic 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; /** - * Section body. + * Returns the name of the readability statistic. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - section = "Section", + readonly name: string; /** - * Header body. + * Returns the value of the grammar statistic. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + readonly value: number; /** - * Footer body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - footer = "Footer", + load(options?: Word.Interfaces.ReadabilityStatisticLoadOptions): Word.ReadabilityStatistic; /** - * Table cell body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableCell = "TableCell", + load(propertyNames?: string | string[]): Word.ReadabilityStatistic; /** - * Footnote body. - * @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 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. */ - footnote = "Footnote", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReadabilityStatistic; /** - * Endnote body. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - endnote = "Endnote", + track(): Word.ReadabilityStatistic; /** - * Note body e.g., endnote, footnote. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - noteItem = "NoteItem", + untrack(): Word.ReadabilityStatistic; /** - * Shape body. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatistic` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticData`) that contains shallow copies of any loaded child properties from the original object. */ - shape = "Shape", + toJSON(): Word.Interfaces.ReadabilityStatisticData; } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum SelectionMode { + export class ReadabilityStatisticCollection 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.ReadabilityStatistic[]; /** - * The entire range is selected. + * Gets the readability statistic at the specified index. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The zero-based index of the readability statistic to get. */ - select = "Select", + getItemAt(index: number): Word.ReadabilityStatistic; /** - * The cursor is at the beginning of the selection (just before the start of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - start = "Start", + load(options?: Word.Interfaces.ReadabilityStatisticCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReadabilityStatisticCollection; /** - * The cursor is at the end of the selection (just after the end of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - end = "End", + load(propertyNames?: string | string[]): Word.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatisticCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ReadabilityStatisticCollectionData; } /** + * Represents the settings for saving a Word document as a webpage. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ImageFormat { + export class WebSettings 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; /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unsupported = "Unsupported", + allowPng: boolean; /** + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - undefined = "Undefined", + encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bmp = "Bmp", + readonly folderSuffix: string; /** + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - jpeg = "Jpeg", + organizeInFolder: boolean; /** + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gif = "Gif", + pixelsPerInch: number; /** + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tiff = "Tiff", + relyOnCSS: boolean; /** + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - png = "Png", + relyOnVectorMarkupLanguage: boolean; /** + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - icon = "Icon", + screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** + * Specifies the target browser for documents viewed in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - exif = "Exif", + targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wmf = "Wmf", + useLongFileNames: boolean; /** + * Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - emf = "Emf", + useDefaultFolderSuffix(): void; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pict = "Pict", + load(options?: Word.Interfaces.WebSettingsLoadOptions): Word.WebSettings; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pdf = "Pdf", + load(propertyNames?: string | string[]): Word.WebSettings; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - svg = "Svg", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.WebSettings; + /** + * 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.WebSettings; + /** + * 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.WebSettings; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WebSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WebSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.WebSettingsData; } /** - * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum RangeLocation { + export class XmlNodeCollection 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.XmlNode[]; /** - * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. + * Gets a `XmlNode` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `XmlNode` object. */ - whole = "Whole", + getItem(index: number): Word.XmlNode; /** - * The starting point of the object. For content control, it's the point after the opening tag. + * Returns an individual `XmlNode` object in a collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the XML node to retrieve. */ - start = "Start", + getItemAt(index: number): Word.XmlNode; /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - end = "End", + load(options?: Word.Interfaces.XmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.XmlNodeCollection; /** - * For content control only. It's the point before the opening tag. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - before = "Before", + load(propertyNames?: string | string[]): Word.XmlNodeCollection; /** - * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - after = "After", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.XmlNodeCollection; /** - * The range between 'Start' and 'End'. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - content = "Content", + track(): Word.XmlNodeCollection; + /** + * 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.XmlNodeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.XmlNodeCollectionData; } /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.setValidationError} method. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum LocationRelation { + export interface XmlNodeSetValidationErrorOptions { /** - * Indicates that this instance and the range are in different sub-documents. + * If provided, specifies whether the validation error should be cleared automatically. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unrelated = "Unrelated", + clearedAutomatically?: boolean; /** - * Indicates that this instance and the range represent the same range. + * If provided, specifies the error text to display for the validation error. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - equal = "Equal", + errorText?: string; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class XmlNode 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; /** - * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Gets the attributes for this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - containsStart = "ContainsStart", + readonly attributes: Word.XmlNodeCollection; /** - * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Gets the child elements of this XML node. Returns an empty collection if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - containsEnd = "ContainsEnd", + readonly childNodes: Word.XmlNodeCollection; /** - * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contains = "Contains", + readonly firstChild: Word.XmlNode; /** - * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideStart = "InsideStart", + readonly lastChild: Word.XmlNode; /** - * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideEnd = "InsideEnd", + readonly nextSibling: Word.XmlNode; /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Gets the parent document of this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + readonly ownerDocument: Word.Document; /** - * Indicates that this instance occurs before, and is adjacent to, the range. + * Gets the parent element of this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - adjacentBefore = "AdjacentBefore", + readonly parentNode: Word.XmlNode; /** - * Indicates that this instance starts before the range and overlaps the range's first character. + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - overlapsBefore = "OverlapsBefore", + readonly previousSibling: Word.XmlNode; /** - * Indicates that this instance occurs before the range. + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + readonly range: Word.Range; /** - * Indicates that this instance occurs after, and is adjacent to, the range. + * Gets the name of the element without any prefix. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - adjacentAfter = "AdjacentAfter", + readonly baseName: string; /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - overlapsAfter = "OverlapsAfter", + readonly hasChildNodes: boolean; /** - * Indicates that this instance occurs after the range. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum BorderLocation { + readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + readonly namespaceUri: string; /** + * Gets the type of node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + readonly nodeType: Word.XmlNodeType | "Element" | "Attribute"; /** + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", + nodeValue: string; /** + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + placeholderText: string; /** + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideHorizontal = "InsideHorizontal", + text: string; /** + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideVertical = "InsideVertical", + readonly validationErrorText: string; /** + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom"; /** + * Copies this XML node, excluding XML markup, to the Clipboard. For attribute nodes, copies only the attribute value as text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outside = "Outside", + copy(): void; /** + * Removes this XML node from the document and places it on the Clipboard. For attribute nodes, removes the attribute from its parent element and copies only the attribute value as text to the clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - all = "All", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum CellPaddingLocation { + cut(): void; /** + * Deletes the XML node from the XML document. For element nodes, removes the entire element and its content; for attribute nodes, removes the attribute from its parent element. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + delete(): void; /** + * Removes a child element from this XML node. This method has no effect if the node type is `attribute` (since attribute nodes have no child elements). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param childElement - The child element to remove. */ - left = "Left", + removeChild(childElement: Word.XmlNode): void; /** + * Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xPath - The XPath expression to evaluate. + * @param options - Optional. Configuration options for the XPath search. + * @returns A collection of XML nodes that match the XPath expression. */ - bottom = "Bottom", + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** + * Returns the first child element that matches the XPath parameter within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xPath - The XPath expression to evaluate. + * @param options - Optional. Configuration options for the XPath search. + * @returns The first XML node that matches the XPath expression, or `null` if no match is found. */ - right = "Right", - } - /** - * Represents the width of a style's border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum BorderWidth { + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * None width. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param status - The validation status to set. + * @param options - Optional. Configuration options for setting the validation error. */ - none = "None", + setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * 0.25 point. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param status - The validation status to set. + * @param options - Optional. Configuration options for setting the validation error. */ - pt025 = "Pt025", + setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * 0.50 point. + * Validates this XML node against the XML schemas that are attached to the document. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pt050 = "Pt050", + validate(): void; /** - * 0.75 point. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt075 = "Pt075", + load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode; /** - * 1.00 point. This is the default. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt100 = "Pt100", + load(propertyNames?: string | string[]): Word.XmlNode; /** - * 1.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt150 = "Pt150", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.XmlNode; /** - * 2.25 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt225 = "Pt225", + track(): Word.XmlNode; /** - * 3.00 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt300 = "Pt300", + untrack(): Word.XmlNode; /** - * 4.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeData`) that contains shallow copies of any loaded child properties from the original object. */ - pt450 = "Pt450", + toJSON(): Word.Interfaces.XmlNodeData; + } + /** + * Specifies the type of an XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum XmlNodeType { /** - * 6.00 points. + * Element node. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pt600 = "Pt600", + element = "Element", /** - * Mixed width. + * Attribute node. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + attribute = "Attribute", } /** + * Specifies the validation status of an XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BorderType { + enum XmlValidationStatus { /** + * The node is valid. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + ok = "Ok", /** + * The node has a custom (user-defined) validation error. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + custom = "Custom", + } + /** + * Specifies the level of an XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum XmlNodeLevel { /** + * Inline node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - single = "Single", + inline = "Inline", /** + * Paragraph node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - double = "Double", + paragraph = "Paragraph", /** + * Row node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + row = "Row", /** + * Cell node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashed = "Dashed", + cell = "Cell", + } + /** + * Specifies which Quick Style set to apply to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ApplyQuickStyleSet { /** + * Resets the Quick Style to the style set in use when the document was opened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashed = "DotDashed", + sessionStart = "SessionStart", /** + * Resets the Quick Style to the style set from the template, if any. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dot2Dashed = "Dot2Dashed", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - triple = "Triple", + template = "Template", + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectNodes} and {@link Word.Document| Document.selectNodes} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectNodesOptions { /** + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickSmall = "ThinThickSmall", + fastSearchSkippingTextNodes?: boolean; /** + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinSmall = "ThickThinSmall", + prefixMapping?: string; + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectSingleNode} and {@link Word.Document| Document.selectSingleNode} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectSingleNodeOptions { /** + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinSmall = "ThinThickThinSmall", + fastSearchSkippingTextNodes?: boolean; /** + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickMed = "ThinThickMed", + prefixMapping?: string; + } + /** + * Specifies the screen size for web page preview and HTML export optimization. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ScreenSize { /** + * Screen resolution 544x376 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinMed = "ThickThinMed", + size544x376 = "Size544x376", /** + * Screen resolution 640x480 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinMed = "ThinThickThinMed", + size640x480 = "Size640x480", /** + * Screen resolution 720x512 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickLarge = "ThinThickLarge", + size720x512 = "Size720x512", /** + * Screen resolution 800x600 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinLarge = "ThickThinLarge", + size800x600 = "Size800x600", /** + * Screen resolution 1024x768 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinLarge = "ThinThickThinLarge", + size1024x768 = "Size1024x768", /** + * Screen resolution 1152x882 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + size1152x882 = "Size1152x882", /** + * Screen resolution 1152x900 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleWave = "DoubleWave", + size1152x900 = "Size1152x900", /** + * Screen resolution 1280x1024 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashedSmall = "DashedSmall", + size1280x1024 = "Size1280x1024", /** + * Screen resolution 1600x1200 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashDotStroked = "DashDotStroked", + size1600x1200 = "Size1600x1200", /** + * Screen resolution 1800x1440 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - threeDEmboss = "ThreeDEmboss", + size1800x1440 = "Size1800x1440", /** + * Screen resolution 1920x1200 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - threeDEngrave = "ThreeDEngrave", + size1920x1200 = "Size1920x1200", } /** + * Specifies the target web browser for HTML export and web page optimization. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum VerticalAlignment { + enum TargetBrowser { /** + * Browser version 3. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + v3 = "V3", /** + * Browser version 4. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + v4 = "V4", /** + * Microsoft Internet Explorer 4. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - center = "Center", + ie4 = "Ie4", /** + * Microsoft Internet Explorer 5. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", + ie5 = "Ie5", + /** + * Microsoft Internet Explorer 6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ie6 = "Ie6", } /** - * Represents the type of baseline alignment. - * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BaselineAlignment { + export class HtmlDivision 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; + readonly htmlDivisions: Word.HtmlDivisionCollection; /** - * Represents top baseline alignment. + * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + readonly range: Word.Range; /** - * Represents center baseline alignment. + * Specifies the left indent value (in points) for this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + leftIndent: number; /** - * Represents baseline alignment. + * Specifies the right indent (in points) for this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseline = "Baseline", + rightIndent: number; /** - * Represents Far East 50% baseline alignment. + * Specifies the amount of spacing (in points) after this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast50 = "FarEast50", + spaceAfter: number; /** - * Represents automatic baseline alignment. + * Specifies the spacing (in points) before this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum ListLevelType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - bullet = "Bullet", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - number = "Number", + spaceBefore: number; /** + * Deletes this HTML division. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum ListBullet { + delete(): void; /** + * Returns an `HtmlDivision` object that represents a parent division of the current HTML division. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param levelsUp - Optional. The number of levels to go up to retrieve the parent division. */ - custom = "Custom", + htmlDivisionParent(levelsUp?: number): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - solid = "Solid", + load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - hollow = "Hollow", + load(propertyNames?: string | string[]): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - square = "Square", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - diamonds = "Diamonds", + track(): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - arrow = "Arrow", + untrack(): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionData`) that contains shallow copies of any loaded child properties from the original object. */ - checkmark = "Checkmark", + toJSON(): Word.Interfaces.HtmlDivisionData; } /** + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListNumbering { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - none = "None", + export class HtmlDivisionCollection 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.HtmlDivision[]; /** + * Returns an `HtmlDivision` object from the collection based on the specified index. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the `HtmlDivision` to retrieve. */ - arabic = "Arabic", + getItemAt(index: number): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - upperRoman = "UpperRoman", + load(options?: Word.Interfaces.HtmlDivisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - lowerRoman = "LowerRoman", + load(propertyNames?: string | string[]): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - upperLetter = "UpperLetter", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - lowerLetter = "LowerLetter", + toJSON(): Word.Interfaces.HtmlDivisionCollectionData; } /** - * Represents the built-in style in a Word document. + * Calendar types. * * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BuiltInStyleName { + enum CalendarType { /** - * Mixed styles or other style not in this list. + * Western calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - other = "Other", + western = "Western", /** - * Reset character and paragraph style to default. + * Arabic calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + arabic = "Arabic", /** + * Hebrew calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading1 = "Heading1", + hebrew = "Hebrew", /** + * Taiwan calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading2 = "Heading2", + taiwan = "Taiwan", /** + * Japanese calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading3 = "Heading3", + japan = "Japan", /** + * Thai calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading4 = "Heading4", + thai = "Thai", /** + * Korean calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading5 = "Heading5", + korean = "Korean", /** + * Saka Era calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading6 = "Heading6", + sakaEra = "SakaEra", /** + * Transliterated English calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading7 = "Heading7", + translitEnglish = "TranslitEnglish", /** + * Transliterated French calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading8 = "Heading8", + translitFrench = "TranslitFrench", /** + * Umm al-Qura calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading9 = "Heading9", + umalqura = "Umalqura", + } + /** + * Date storage formats for {@link Word.DatePickerContentControl}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlDateStorageFormat { /** - * Table-of-content level 1. + * Stores the date as text. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc1 = "Toc1", + text = "Text", /** - * Table-of-content level 2. + * Stores the date as a date object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc2 = "Toc2", + date = "Date", /** - * Table-of-content level 3. + * Stores the date as a date-time object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc3 = "Toc3", + dateTime = "DateTime", + } + /** + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Frame 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; /** - * Table-of-content level 4. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc4 = "Toc4", + readonly borders: Word.BorderUniversalCollection; /** - * Table-of-content level 5. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc5 = "Toc5", + readonly range: Word.Range; /** - * Table-of-content level 6. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc6 = "Toc6", + readonly shading: Word.ShadingUniversal; /** - * Table-of-content level 7. + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc7 = "Toc7", + height: number; /** - * Table-of-content level 8. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc8 = "Toc8", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Table-of-content level 9. + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc9 = "Toc9", + horizontalDistanceFromText: number; /** + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteText = "FootnoteText", + horizontalPosition: number; /** + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + lockAnchor: boolean; /** + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footer = "Footer", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - caption = "Caption", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteReference = "FootnoteReference", + textWrap: boolean; /** + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnoteReference = "EndnoteReference", + verticalDistanceFromText: number; /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnoteText = "EndnoteText", + verticalPosition: number; /** + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title = "Title", + width: number; /** + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtitle = "Subtitle", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - hyperlink = "Hyperlink", + set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Frame): void; /** + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strong = "Strong", + copy(): void; /** + * Removes the frame from the document and places it on the Clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - emphasis = "Emphasis", + cut(): void; /** + * Deletes the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noSpacing = "NoSpacing", + delete(): void; /** + * Selects the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listParagraph = "ListParagraph", + select(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - quote = "Quote", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - intenseQuote = "IntenseQuote", + load(propertyNames?: string | string[]): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - subtleEmphasis = "SubtleEmphasis", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - intenseEmphasis = "IntenseEmphasis", + track(): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - subtleReference = "SubtleReference", + untrack(): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. */ - intenseReference = "IntenseReference", + toJSON(): Word.Interfaces.FrameData; + } + /** + * Represents the collection of {@link Word.Frame} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class FrameCollection 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.Frame[]; /** + * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range where the frame will be added. + * @returns A `Frame` object that represents the new frame. */ - bookTitle = "BookTitle", + add(range: Word.Range): Word.Frame; /** + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bibliography = "Bibliography", + delete(): void; /** - * Table-of-content heading. + * Gets a `Frame` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `Frame` object. */ - tocHeading = "TocHeading", + getItem(index: number): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableGrid = "TableGrid", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable1 = "PlainTable1", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable2 = "PlainTable2", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable3 = "PlainTable3", + track(): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable4 = "PlainTable4", + untrack(): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - plainTable5 = "PlainTable5", + toJSON(): Word.Interfaces.FrameCollectionData; + } + /** + * Represents a document library version. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class DocumentLibraryVersion 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 any optional comments associated with this version of the shared document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableGridLight = "TableGridLight", + readonly comments: string; /** + * Gets the date and time at which this version of the shared document was last saved to the server. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light = "GridTable1Light", + readonly modified: any; /** + * Gets the name of the user who last saved this version of the shared document to the server. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + readonly modifiedBy: string; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + track(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + untrack(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. */ - gridTable2 = "GridTable2", + toJSON(): Word.Interfaces.DocumentLibraryVersionData; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class DocumentLibraryVersionCollection 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.DocumentLibraryVersion[]; /** + * Gets a `DocumentLibraryVersion` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `DocumentLibraryVersion` object. */ - gridTable2_Accent1 = "GridTable2_Accent1", + getItem(index: number): Word.DocumentLibraryVersion; /** + * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable2_Accent2 = "GridTable2_Accent2", + isVersioningEnabled(): OfficeExtension.ClientResult; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent3 = "GridTable2_Accent3", + load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent4 = "GridTable2_Accent4", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent5 = "GridTable2_Accent5", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent6 = "GridTable2_Accent6", + track(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable3 = "GridTable3", + untrack(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - gridTable3_Accent1 = "GridTable3_Accent1", + toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + } + /** + * Represents the possible change tracking modes. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingMode { /** + * ChangeTracking is turned off. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent2 = "GridTable3_Accent2", + off = "Off", /** + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent3 = "GridTable3_Accent3", + trackAll = "TrackAll", /** + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent4 = "GridTable3_Accent4", + 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.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent5 = "GridTable3_Accent5", + original = "Original", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent6 = "GridTable3_Accent6", + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4 = "GridTable4", + unknown = "Unknown", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent1 = "GridTable4_Accent1", + normal = "Normal", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent2 = "GridTable4_Accent2", + added = "Added", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent3 = "GridTable4_Accent3", + deleted = "Deleted", + } + /** + * TrackedChange type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + enum TrackedChangeType { /** + * No revision. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent4 = "GridTable4_Accent4", + none = "None", /** + * Add change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent5 = "GridTable4_Accent5", + added = "Added", /** + * Delete change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent6 = "GridTable4_Accent6", + deleted = "Deleted", /** + * Format change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable5Dark = "GridTable5Dark", + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + footnote = "Footnote", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + endnote = "Endnote", + } + /** + * Provides information about the type of a raised event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventType { /** + * ContentControlDeleted represents the event that the content control has been deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + contentControlDeleted = "ContentControlDeleted", /** + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + contentControlSelectionChanged = "ContentControlSelectionChanged", /** + * ContentControlDataChanged represents the event that the data in the content control have been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + contentControlDataChanged = "ContentControlDataChanged", /** + * ContentControlAdded represents the event a content control has been added to the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + contentControlAdded = "ContentControlAdded", /** + * Represents that one or more comments were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful = "GridTable6Colorful", + commentDeleted = "CommentDeleted", /** + * Represents that a comment was selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + commentSelected = "CommentSelected", /** + * Represents that a comment was deselected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + commentDeselected = "CommentDeselected", /** + * Represents that a comment or its reply was changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + commentChanged = "CommentChanged", /** + * Represents that one or more new comments were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + commentAdded = "CommentAdded", /** + * Represents that a content control has been entered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + contentControlEntered = "ContentControlEntered", /** + * Represents that a content control has been exited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + contentControlExited = "ContentControlExited", /** + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful = "GridTable7Colorful", + paragraphAdded = "ParagraphAdded", /** + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + paragraphChanged = "ParagraphChanged", /** + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + paragraphDeleted = "ParagraphDeleted", /** + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + annotationClicked = "AnnotationClicked", /** + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + annotationHovered = "AnnotationHovered", /** + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + annotationInserted = "AnnotationInserted", /** + * Represents that one or more annotations were deleted from the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + annotationRemoved = "AnnotationRemoved", /** + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - listTable1Light = "ListTable1Light", + annotationPopupAction = "AnnotationPopupAction", + } + /** + * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventSource { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + local = "Local", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + remote = "Remote", + } + /** + * Provides information about the content control that raised contentControlAdded event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlAddedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] - */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", - /** - * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDataChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDataChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2 = "ListTable2", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent1 = "ListTable2_Accent1", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent2 = "ListTable2_Accent2", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDeleted event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDeletedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent3 = "ListTable2_Accent3", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent4 = "ListTable2_Accent4", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent5 = "ListTable2_Accent5", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlEntered event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlEnteredEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent6 = "ListTable2_Accent6", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3 = "ListTable3", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent1 = "ListTable3_Accent1", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlExited event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlExitedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent2 = "ListTable3_Accent2", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent3 = "ListTable3_Accent3", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent4 = "ListTable3_Accent4", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class DropCap 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 distance (in points) between the dropped capital letter and the paragraph text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable3_Accent5 = "ListTable3_Accent5", + readonly distanceFromText: number; /** + * Gets the name of the font for the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable3_Accent6 = "ListTable3_Accent6", + readonly fontName: string; /** + * Gets the height (in lines) of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4 = "ListTable4", + readonly linesToDrop: number; /** + * Gets the position of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent1 = "ListTable4_Accent1", + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** + * Removes the dropped capital letter formatting. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent2 = "ListTable4_Accent2", + clear(): void; /** + * Formats the first character in the specified paragraph as a dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent3 = "ListTable4_Accent3", + enable(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent4 = "ListTable4_Accent4", + load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent5 = "ListTable4_Accent5", + load(propertyNames?: string | string[]): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent6 = "ListTable4_Accent6", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable5Dark = "ListTable5Dark", + track(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + untrack(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + toJSON(): Word.Interfaces.DropCapData; + } + /** + * Provides information about the content control that raised contentControlSelectionChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlSelectionChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the paragraphs that raised the paragraphAdded event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphAddedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful = "ListTable6Colorful", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphChangedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphDeleted event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphDeletedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable7Colorful = "ListTable7Colorful", + uniqueLocalIds: string[]; + } + /** + * Provides information about the comments that raised the comment event. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CommentEventArgs { /** + * Represents how the comment changed event is triggered. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** + * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + commentDetails: Word.CommentDetail[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + } + /** + * A structure for the ID and reply IDs of this comment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CommentDetail { /** + * Represents the ID of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + id: string; /** + * Represents the IDs of the replies to this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + replyIds: string[]; } /** + * Represents how the comments in the event were changed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum DocumentPropertyType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - string = "String", + enum CommentChangeType { /** + * No comment changed event is triggered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - number = "Number", + none = "none", /** + * A comment was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date = "Date", + edited = "edited", /** + * A comment was resolved. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boolean = "Boolean", - } - /** - * Represents the type of style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum StyleType { + resolved = "resolved", /** - * Represents that the style is a character style. + * A comment was reopened. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - character = "Character", + reopened = "reopened", /** - * Represents that the style is a list style. Currently supported on desktop. + * A reply was added. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - list = "List", + replyAdded = "replyAdded", /** - * Represents that the style is a paragraph style. + * A reply was deleted. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph = "Paragraph", + replyDeleted = "replyDeleted", /** - * Represents that the style is a table style. + * A reply was edited. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - table = "Table", + replyEdited = "replyEdited", } /** - * Represents the outline levels. + * Specifies supported content control types and subtypes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - enum OutlineLevel { + enum ContentControlType { /** - * Represents outline level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel1 = "OutlineLevel1", + unknown = "Unknown", /** - * Represents outline level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel2 = "OutlineLevel2", + richTextInline = "RichTextInline", /** - * Represents outline level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel3 = "OutlineLevel3", + richTextParagraphs = "RichTextParagraphs", /** - * Represents outline level 4. + * Contains a whole cell. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel4 = "OutlineLevel4", + richTextTableCell = "RichTextTableCell", /** - * Represents outline level 5. + * Contains a whole row. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel5 = "OutlineLevel5", + richTextTableRow = "RichTextTableRow", /** - * Represents outline level 6. + * Contains a whole table. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel6 = "OutlineLevel6", + richTextTable = "RichTextTable", /** - * Represents outline level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel7 = "OutlineLevel7", + plainTextInline = "PlainTextInline", /** - * Represents outline level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel8 = "OutlineLevel8", + plainTextParagraph = "PlainTextParagraph", /** - * Represents outline level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel9 = "OutlineLevel9", + picture = "Picture", /** - * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevelBodyText = "OutlineLevelBodyText", - } - /** - * Specifies the close behavior for `Document.close`. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum CloseBehavior { + buildingBlockGallery = "BuildingBlockGallery", /** - * Saves the changes before closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - save = "Save", + checkBox = "CheckBox", /** - * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - skipSave = "SkipSave", + comboBox = "ComboBox", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + dropDownList = "DropDownList", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + datePicker = "DatePicker", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + repeatingSection = "RepeatingSection", + /** + * Identifies a rich text content control. + * @remarks + * [Api set: WordApi 1.1] + */ + richText = "RichText", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + plainText = "PlainText", + /** + * @remarks + * [Api set: WordApi 1.1] + */ + group = "Group", } /** - * Specifies the save behavior for `Document.save`. + * ContentControl appearance. * * @remarks * [Api set: WordApi 1.1] + * + * Content control appearance options are BoundingBox, Tags, or Hidden. */ - enum SaveBehavior { + enum ContentControlAppearance { /** - * Saves the document without prompting the user. If it's a new document, - it will be saved with the default name or specified name in the default location. + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). * @remarks * [Api set: WordApi 1.1] */ - save = "Save", + boundingBox = "BoundingBox", /** - * Displays the "Save As" dialog to the user if the document hasn't been saved. - Won't take effect if the document was previously saved. + * Represents a content control shown as start and end markers. * @remarks * [Api set: WordApi 1.1] */ - prompt = "Prompt", + tags = "Tags", + /** + * Represents a content control that isn't shown. + * @remarks + * [Api set: WordApi 1.1] + */ + hidden = "Hidden", } /** - * Represents the type of Field. + * Content control level types. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum FieldType { + enum ContentControlLevel { /** - * Represents that the field type is Add-in. + * Represents an inline content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addin = "Addin", + inline = "Inline", /** - * Represents that the field type is AddressBlock. + * Represents a paragraph-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addressBlock = "AddressBlock", + paragraph = "Paragraph", /** - * Represents that the field type is Advance. + * Represents a row-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - advance = "Advance", + row = "Row", /** - * Represents that the field type is Ask. + * Represents a cell-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ask = "Ask", + cell = "Cell", + } + /** + * Represents the state of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlState { /** - * Represents that the field type is Author. + * Error state. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author = "Author", + error = "Error", /** - * Represents that the field type is AutoText. + * Warning state. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoText = "AutoText", + warning = "Warning", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { /** - * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - autoTextList = "AutoTextList", + mixed = "Mixed", /** - * Represents that the field type is Barcode. + * No underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - barCode = "BarCode", + none = "None", /** - * Represents that the field type is Bibliography. + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - bibliography = "Bibliography", + hidden = "Hidden", /** - * Represents that the field type is BidiOutline. + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - bidiOutline = "BidiOutline", + dotLine = "DotLine", /** - * Represents that the field type is Citation. + * A single underline. This is the default value. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - citation = "Citation", + single = "Single", /** - * Represents that the field type is Comments. + * Only underline individual words. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - comments = "Comments", + word = "Word", /** - * Represents that the field type is Compare. + * A double underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - compare = "Compare", + double = "Double", /** - * Represents that the field type is CreateDate. + * A single thick underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - createDate = "CreateDate", + thick = "Thick", /** - * Represents that the field type is Data. + * A dotted underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data = "Data", + dotted = "Dotted", /** - * Represents that the field type is Database. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - database = "Database", + dottedHeavy = "DottedHeavy", /** - * Represents that the field type is Date. + * A single dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - date = "Date", + dashLine = "DashLine", /** - * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - displayBarcode = "DisplayBarcode", + dashLineHeavy = "DashLineHeavy", /** - * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - docProperty = "DocProperty", + dashLineLong = "DashLineLong", /** - * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - docVariable = "DocVariable", + dashLineLongHeavy = "DashLineLongHeavy", /** - * Represents that the field type is EditTime. + * An alternating dot-dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - editTime = "EditTime", + dotDashLine = "DotDashLine", /** - * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - embedded = "Embedded", + dotDashLineHeavy = "DotDashLineHeavy", /** - * Represents that the field type is Equation. + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - eq = "EQ", + twoDotDashLine = "TwoDotDashLine", /** - * Represents that the field type is Expression. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - expression = "Expression", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** - * Represents that the field type is FileName. + * A single wavy underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fileName = "FileName", + wave = "Wave", /** - * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fileSize = "FileSize", + waveHeavy = "WaveHeavy", /** - * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fillIn = "FillIn", + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { /** - * Represents that the field type is FormCheckbox. + * Page break at the insertion point. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formCheckbox = "FormCheckbox", + page = "Page", /** - * Represents that the field type is FormDropdown. + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formDropdown = "FormDropdown", + next = "Next", /** - * Represents that the field type is FormText. + * Section break on next page. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formText = "FormText", + sectionNext = "SectionNext", /** - * Represents that the field type is GotoButton. + * New section without a corresponding page break. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - gotoButton = "GotoButton", + sectionContinuous = "SectionContinuous", /** - * Represents that the field type is GreetingLine. + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - greetingLine = "GreetingLine", + sectionEven = "SectionEven", /** - * Represents that the field type is Hyperlink. + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - hyperlink = "Hyperlink", + sectionOdd = "SectionOdd", /** - * Represents that the field type is If. + * Line break. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - if = "If", + line = "Line", + } + /** + * The insertion location types. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is "Before" or "After", the new content will be outside of the modified object. + * If the location is "Start" or "End", the new content will be included as part of the modified object. + */ + enum InsertLocation { /** - * Represents that the field type is Import. + * Add content before the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - import = "Import", + before = "Before", /** - * Represents that the field type is Include. + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - include = "Include", + after = "After", /** - * Represents that the field type is IncludePicture. + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - includePicture = "IncludePicture", + start = "Start", /** - * Represents that the field type is IncludeText. + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - includeText = "IncludeText", + end = "End", /** - * Represents that the field type is Index. + * Replace the contents of the current object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - index = "Index", + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** - * Represents that the field type is Information. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - info = "Info", + mixed = "Mixed", /** - * Represents that the field type is Keywords. + * Unknown alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - keywords = "Keywords", + unknown = "Unknown", /** - * Represents that the field type is LastSavedBy. + * Alignment to the left. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - lastSavedBy = "LastSavedBy", + left = "Left", /** - * Represents that the field type is Link. + * Alignment to the center. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - link = "Link", + centered = "Centered", /** - * Represents that the field type is ListNumber. + * Alignment to the right. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - listNum = "ListNum", + right = "Right", /** - * Represents that the field type is MacroButton. + * Fully justified alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - macroButton = "MacroButton", + justified = "Justified", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { /** - * Represents that the field type is MergeBarcode. + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeBarcode = "MergeBarcode", + primary = "Primary", /** - * Represents that the field type is MergeField. + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeField = "MergeField", + firstPage = "FirstPage", /** - * Represents that the field type is MergeRecord. + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeRec = "MergeRec", + evenPages = "EvenPages", + } + /** + * Represents the types of body objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BodyType { /** - * Represents that the field type is MergeSequence. + * Unknown body type. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeSeq = "MergeSeq", + unknown = "Unknown", /** - * Represents that the field type is Next. + * Main document body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - next = "Next", + mainDoc = "MainDoc", /** - * Represents that the field type is NextIf. + * Section body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nextIf = "NextIf", + section = "Section", /** - * Represents that the field type is NoteReference. + * Header body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - noteRef = "NoteRef", + header = "Header", /** - * Represents that the field type is NumberOfCharacters. + * Footer body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numChars = "NumChars", + footer = "Footer", /** - * Represents that the field type is NumberOfPages. + * Table cell body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numPages = "NumPages", + tableCell = "TableCell", /** - * Represents that the field type is NumberOfWords. + * Footnote body. * @remarks * [Api set: WordApi 1.5] */ - numWords = "NumWords", + footnote = "Footnote", /** - * Represents that the field type is ActiveXControl. + * Endnote body. * @remarks * [Api set: WordApi 1.5] */ - ocx = "OCX", + endnote = "Endnote", /** - * Represents that the field type is Page. + * Note body e.g., endnote, footnote. * @remarks * [Api set: WordApi 1.5] */ - page = "Page", + noteItem = "NoteItem", /** - * Represents that the field type is PageReference. + * Shape body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pageRef = "PageRef", + shape = "Shape", + } + /** + * This enum sets where the cursor (insertion point) in the document is after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { /** - * Represents that the field type is Print. + * The entire range is selected. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - print = "Print", + select = "Select", /** - * Represents that the field type is PrintDate. + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - printDate = "PrintDate", + start = "Start", /** - * Represents that the field type is Private. + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - private = "Private", + end = "End", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** - * Represents that the field type is Quote. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - quote = "Quote", + unsupported = "Unsupported", /** - * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - rd = "RD", + undefined = "Undefined", /** - * Represents that the field type is Reference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - ref = "Ref", + bmp = "Bmp", /** - * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - revNum = "RevNum", + jpeg = "Jpeg", /** - * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - saveDate = "SaveDate", + gif = "Gif", /** - * Represents that the field type is Section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - section = "Section", + tiff = "Tiff", /** - * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - sectionPages = "SectionPages", + png = "Png", /** - * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - seq = "Seq", + icon = "Icon", /** - * Represents that the field type is Set. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - set = "Set", + exif = "Exif", /** - * Represents that the field type is Shape. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - shape = "Shape", + wmf = "Wmf", /** - * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - skipIf = "SkipIf", + emf = "Emf", /** - * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - styleRef = "StyleRef", + pict = "Pict", /** - * Represents that the field type is Subject. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - subject = "Subject", + pdf = "Pdf", /** - * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - subscriber = "Subscriber", + svg = "Svg", + } + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { /** - * Represents that the field type is Symbol. + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - symbol = "Symbol", + whole = "Whole", /** - * Represents that the field type is TableOfAuthoritiesEntry. + * The starting point of the object. For content control, it's the point after the opening tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ta = "TA", + start = "Start", /** - * Represents that the field type is TableOfContentsEntry. + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - tc = "TC", + end = "End", /** - * Represents that the field type is Template. + * For content control only. It's the point before the opening tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - template = "Template", + before = "Before", /** - * Represents that the field type is Time. + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - time = "Time", + after = "After", /** - * Represents that the field type is Title. + * The range between 'Start' and 'End'. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - title = "Title", + content = "Content", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { /** - * Represents that the field type is TableOfAuthorities. + * Indicates that this instance and the range are in different sub-documents. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toa = "TOA", + unrelated = "Unrelated", /** - * Represents that the field type is TableOfContents. + * Indicates that this instance and the range represent the same range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toc = "TOC", + equal = "Equal", /** - * Represents that the field type is UserAddress. + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userAddress = "UserAddress", + containsStart = "ContainsStart", /** - * Represents that the field type is UserInitials. + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userInitials = "UserInitials", + containsEnd = "ContainsEnd", /** - * Represents that the field type is UserName. + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userName = "UserName", + contains = "Contains", /** - * Represents that the field type is IndexEntry. + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - xe = "XE", + insideStart = "InsideStart", /** - * Represents that the field type is Empty. + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - empty = "Empty", + insideEnd = "InsideEnd", /** - * Represents the field types not supported by the Office JavaScript API. + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - others = "Others", + inside = "Inside", /** - * Represents that the field type is Undefined. + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - undefined = "Undefined", - } - /** - * Represents the kind of field. Indicates how the field works in relation to updating. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldKind { + adjacentBefore = "AdjacentBefore", /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - none = "None", + overlapsBefore = "OverlapsBefore", /** - * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. + * Indicates that this instance occurs before the range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hot = "Hot", + before = "Before", /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - warm = "Warm", + adjacentAfter = "AdjacentAfter", /** - * Represents that the field doesn't have a result. + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - cold = "Cold", + overlapsAfter = "OverlapsAfter", + /** + * Indicates that this instance occurs after the range. + * @remarks + * [Api set: WordApi 1.3] + */ + after = "After", } /** - * Represents the character inserted after the list item mark. - * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - enum TrailingCharacter { + enum BorderLocation { /** - * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingTab = "TrailingTab", + top = "Top", /** - * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingSpace = "TrailingSpace", + left = "Left", /** - * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingNone = "TrailingNone", - } - /** - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ListBuiltInNumberStyle { + bottom = "Bottom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + right = "Right", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + insideHorizontal = "InsideHorizontal", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperRoman = "UpperRoman", + insideVertical = "InsideVertical", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerRoman = "LowerRoman", + inside = "Inside", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperLetter = "UpperLetter", + outside = "Outside", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerLetter = "LowerLetter", + all = "All", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinal = "Ordinal", + top = "Top", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - cardinalText = "CardinalText", + left = "Left", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinalText = "OrdinalText", + bottom = "Bottom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanji = "Kanji", + right = "Right", + } + /** + * Represents the width of a style's border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum BorderWidth { /** + * None width. * @remarks * [Api set: WordApiDesktop 1.1] */ - kanjiDigit = "KanjiDigit", + none = "None", /** + * 0.25 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - aiueoHalfWidth = "AiueoHalfWidth", + pt025 = "Pt025", /** + * 0.50 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - irohaHalfWidth = "IrohaHalfWidth", + pt050 = "Pt050", /** + * 0.75 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - arabicFullWidth = "ArabicFullWidth", + pt075 = "Pt075", /** + * 1.00 point. This is the default. * @remarks * [Api set: WordApiDesktop 1.1] */ - kanjiTraditional = "KanjiTraditional", + pt100 = "Pt100", /** + * 1.50 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - kanjiTraditional2 = "KanjiTraditional2", + pt150 = "Pt150", /** + * 2.25 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - numberInCircle = "NumberInCircle", + pt225 = "Pt225", /** + * 3.00 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - aiueo = "Aiueo", + pt300 = "Pt300", /** + * 4.50 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - iroha = "Iroha", + pt450 = "Pt450", /** + * 6.00 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - arabicLZ = "ArabicLZ", + pt600 = "Pt600", /** + * Mixed width. * @remarks * [Api set: WordApiDesktop 1.1] */ - bullet = "Bullet", + mixed = "Mixed", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ganada = "Ganada", + mixed = "Mixed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - chosung = "Chosung", + none = "None", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum1 = "GBNum1", + single = "Single", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum2 = "GBNum2", + double = "Double", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum3 = "GBNum3", + dotted = "Dotted", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum4 = "GBNum4", + dashed = "Dashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac1 = "Zodiac1", + dotDashed = "DotDashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac2 = "Zodiac2", + dot2Dashed = "Dot2Dashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac3 = "Zodiac3", + triple = "Triple", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum1 = "TradChinNum1", + thinThickSmall = "ThinThickSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum2 = "TradChinNum2", + thickThinSmall = "ThickThinSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum3 = "TradChinNum3", + thinThickThinSmall = "ThinThickThinSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum4 = "TradChinNum4", + thinThickMed = "ThinThickMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum1 = "SimpChinNum1", + thickThinMed = "ThickThinMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum2 = "SimpChinNum2", + thinThickThinMed = "ThinThickThinMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum3 = "SimpChinNum3", + thinThickLarge = "ThinThickLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum4 = "SimpChinNum4", + thickThinLarge = "ThickThinLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaRead = "HanjaRead", + thinThickThinLarge = "ThinThickThinLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + wave = "Wave", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hangul = "Hangul", + doubleWave = "DoubleWave", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanja = "Hanja", + dashedSmall = "DashedSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew1 = "Hebrew1", + dashDotStroked = "DashDotStroked", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic1 = "Arabic1", + threeDEmboss = "ThreeDEmboss", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew2 = "Hebrew2", + threeDEngrave = "ThreeDEngrave", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum VerticalAlignment { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic2 = "Arabic2", + mixed = "Mixed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter1 = "HindiLetter1", + top = "Top", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter2 = "HindiLetter2", + center = "Center", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiArabic = "HindiArabic", + bottom = "Bottom", + } + /** + * Represents the type of baseline alignment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BaselineAlignment { /** + * Represents top baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hindiCardinalText = "HindiCardinalText", + top = "Top", /** + * Represents center baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thaiLetter = "ThaiLetter", + center = "Center", /** + * Represents baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thaiArabic = "ThaiArabic", + baseline = "Baseline", /** + * Represents Far East 50% baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thaiCardinalText = "ThaiCardinalText", + farEast50 = "FarEast50", /** + * Represents automatic baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vietCardinalText = "VietCardinalText", + auto = "Auto", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListLevelType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseRussian = "LowercaseRussian", + bullet = "Bullet", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseRussian = "UppercaseRussian", + number = "Number", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseGreek = "LowercaseGreek", + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseGreek = "UppercaseGreek", + custom = "Custom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ2 = "ArabicLZ2", + solid = "Solid", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ3 = "ArabicLZ3", + hollow = "Hollow", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ4 = "ArabicLZ4", + square = "Square", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseTurkish = "LowercaseTurkish", + diamonds = "Diamonds", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseTurkish = "UppercaseTurkish", + arrow = "Arrow", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseBulgarian = "LowercaseBulgarian", + checkmark = "Checkmark", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListNumbering { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseBulgarian = "UppercaseBulgarian", + none = "None", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pictureBullet = "PictureBullet", + arabic = "Arabic", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - legal = "Legal", + upperRoman = "UpperRoman", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - legalLZ = "LegalLZ", + lowerRoman = "LowerRoman", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + upperLetter = "UpperLetter", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + lowerLetter = "LowerLetter", } /** - * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Represents the built-in style in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. */ - enum ShadingTextureType { + enum BuiltInStyleName { /** - * Represents dark diagonal-down texture. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalDown = "DarkDiagonalDown", + other = "Other", /** - * Represents dark diagonal-up texture. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalUp = "DarkDiagonalUp", + normal = "Normal", /** - * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkGrid = "DarkGrid", + heading1 = "Heading1", /** - * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkHorizontal = "DarkHorizontal", + heading2 = "Heading2", /** - * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkTrellis = "DarkTrellis", + heading3 = "Heading3", /** - * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkVertical = "DarkVertical", + heading4 = "Heading4", /** - * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightDiagonalDown = "LightDiagonalDown", + heading5 = "Heading5", /** - * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightDiagonalUp = "LightDiagonalUp", + heading6 = "Heading6", /** - * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightGrid = "LightGrid", + heading7 = "Heading7", /** - * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightHorizontal = "LightHorizontal", + heading8 = "Heading8", /** - * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightTrellis = "LightTrellis", + heading9 = "Heading9", /** - * Represents light vertical texture. + * Table-of-content level 1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightVertical = "LightVertical", + toc1 = "Toc1", /** - * Represents that there's no texture. + * Table-of-content level 2. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + toc2 = "Toc2", /** - * Represents 10 percent texture. + * Table-of-content level 3. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent10 = "Percent10", + toc3 = "Toc3", /** - * Represents 12.5 percent texture. + * Table-of-content level 4. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent12Pt5 = "Percent12Pt5", + toc4 = "Toc4", /** - * Represents 15 percent texture. + * Table-of-content level 5. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent15 = "Percent15", + toc5 = "Toc5", /** - * Represents 20 percent texture. + * Table-of-content level 6. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent20 = "Percent20", + toc6 = "Toc6", /** - * Represents 25 percent texture. + * Table-of-content level 7. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent25 = "Percent25", + toc7 = "Toc7", /** - * Represents 30 percent texture. + * Table-of-content level 8. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent30 = "Percent30", + toc8 = "Toc8", /** - * Represents 35 percent texture. + * Table-of-content level 9. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent35 = "Percent35", + toc9 = "Toc9", /** - * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent37Pt5 = "Percent37Pt5", + footnoteText = "FootnoteText", /** - * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent40 = "Percent40", + header = "Header", /** - * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent45 = "Percent45", + footer = "Footer", /** - * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent5 = "Percent5", + caption = "Caption", /** - * Represents 50 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent50 = "Percent50", + footnoteReference = "FootnoteReference", /** - * Represents 55 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent55 = "Percent55", + endnoteReference = "EndnoteReference", /** - * Represents 60 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent60 = "Percent60", + endnoteText = "EndnoteText", /** - * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent62Pt5 = "Percent62Pt5", + title = "Title", /** - * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent65 = "Percent65", + subtitle = "Subtitle", /** - * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent70 = "Percent70", + hyperlink = "Hyperlink", /** - * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent75 = "Percent75", + strong = "Strong", /** - * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent80 = "Percent80", + emphasis = "Emphasis", /** - * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent85 = "Percent85", + noSpacing = "NoSpacing", /** - * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent87Pt5 = "Percent87Pt5", + listParagraph = "ListParagraph", /** - * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent90 = "Percent90", + quote = "Quote", /** - * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent95 = "Percent95", + intenseQuote = "IntenseQuote", /** - * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - solid = "Solid", - } - /** - * Specifies the target document for displaying document comparison differences. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum CompareTarget { + subtleEmphasis = "SubtleEmphasis", /** - * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetCurrent = "CompareTargetCurrent", + intenseEmphasis = "IntenseEmphasis", /** - * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetSelected = "CompareTargetSelected", + subtleReference = "SubtleReference", /** - * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetNew = "CompareTargetNew", - } - /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImportedStylesConflictBehavior { + intenseReference = "IntenseReference", /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ignore = "Ignore", + bookTitle = "BookTitle", /** - * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - overwrite = "Overwrite", + bibliography = "Bibliography", /** - * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. + * Table-of-content heading. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - createNew = "CreateNew", - } - /** - * Represents the shape type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeType { + tocHeading = "TocHeading", /** - * Unsupported shape type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - unsupported = "Unsupported", + tableGrid = "TableGrid", /** - * Text box shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - textBox = "TextBox", + plainTable1 = "PlainTable1", /** - * Geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - geometricShape = "GeometricShape", + plainTable2 = "PlainTable2", /** - * Group shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - group = "Group", + plainTable3 = "PlainTable3", /** - * Picture shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - picture = "Picture", + plainTable4 = "PlainTable4", /** - * Canvas shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - canvas = "Canvas", - } - /** - * 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: WordApiDesktop 1.2] - */ - enum RelativeHorizontalPosition { + plainTable5 = "PlainTable5", /** - * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + tableGridLight = "TableGridLight", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable1Light = "GridTable1Light", /** - * Relative to column. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - column = "Column", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Relative to character. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - character = "Character", + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Relative to left margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftMargin = "LeftMargin", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * Relative to right margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightMargin = "RightMargin", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - 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: WordApiDesktop 1.2] - */ - enum RelativeVerticalPosition { + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + gridTable2 = "GridTable2", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * Relative to paragraph. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - paragraph = "Paragraph", + gridTable2_Accent2 = "GridTable2_Accent2", /** - * Relative to line. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - line = "Line", + gridTable2_Accent3 = "GridTable2_Accent3", /** - * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topMargin = "TopMargin", + gridTable2_Accent4 = "GridTable2_Accent4", /** - * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bottomMargin = "BottomMargin", + gridTable2_Accent5 = "GridTable2_Accent5", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + gridTable2_Accent6 = "GridTable2_Accent6", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the horizontal or vertical size 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: WordApiDesktop 1.2] - */ - enum RelativeSize { + gridTable3 = "GridTable3", /** - * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + gridTable3_Accent1 = "GridTable3_Accent1", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable3_Accent2 = "GridTable3_Accent2", /** - * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topMargin = "TopMargin", + gridTable3_Accent3 = "GridTable3_Accent3", /** - * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bottomMargin = "BottomMargin", + gridTable3_Accent4 = "GridTable3_Accent4", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + gridTable3_Accent5 = "GridTable3_Accent5", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - outsideMargin = "OutsideMargin", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum GeometricShapeType { + gridTable3_Accent6 = "GridTable3_Accent6", /** - * Line inverse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lineInverse = "LineInverse", + gridTable4 = "GridTable4", /** - * Triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - triangle = "Triangle", + gridTable4_Accent1 = "GridTable4_Accent1", /** - * Right triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightTriangle = "RightTriangle", + gridTable4_Accent2 = "GridTable4_Accent2", /** - * Rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rectangle = "Rectangle", + gridTable4_Accent3 = "GridTable4_Accent3", /** - * Diamond geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - diamond = "Diamond", + gridTable4_Accent4 = "GridTable4_Accent4", /** - * Parallelogram geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - parallelogram = "Parallelogram", + gridTable4_Accent5 = "GridTable4_Accent5", /** - * Trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - trapezoid = "Trapezoid", + gridTable4_Accent6 = "GridTable4_Accent6", /** - * Non-isosceles trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + gridTable5Dark = "GridTable5Dark", /** - * Pentagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pentagon = "Pentagon", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** - * Hexagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - hexagon = "Hexagon", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** - * Heptagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heptagon = "Heptagon", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** - * Octagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - octagon = "Octagon", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** - * Decagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - decagon = "Decagon", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** - * Dodecagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - dodecagon = "Dodecagon", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** - * Star 4-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star4 = "Star4", + gridTable6Colorful = "GridTable6Colorful", /** - * Star 5-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star5 = "Star5", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** - * Star 6-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star6 = "Star6", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** - * Star 7-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star7 = "Star7", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** - * Star 8-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star8 = "Star8", + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** - * Star 10-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star10 = "Star10", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** - * Star 12-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star12 = "Star12", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** - * Star 16-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star16 = "Star16", + gridTable7Colorful = "GridTable7Colorful", /** - * Star 24-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star24 = "Star24", + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** - * Star 32-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star32 = "Star32", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** - * Round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - roundRectangle = "RoundRectangle", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** - * Round one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round1Rectangle = "Round1Rectangle", + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** - * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round2SameRectangle = "Round2SameRectangle", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** - * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** - * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snipRoundRectangle = "SnipRoundRectangle", + listTable1Light = "ListTable1Light", /** - * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip1Rectangle = "Snip1Rectangle", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** - * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip2SameRectangle = "Snip2SameRectangle", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** - * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** - * Plaque geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - plaque = "Plaque", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** - * Ellipse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - ellipse = "Ellipse", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** - * Teardrop geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - teardrop = "Teardrop", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** - * Home plate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - homePlate = "HomePlate", + listTable2 = "ListTable2", /** - * Chevron geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - chevron = "Chevron", + listTable2_Accent1 = "ListTable2_Accent1", /** - * Pie wedge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pieWedge = "PieWedge", + listTable2_Accent2 = "ListTable2_Accent2", /** - * Pie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pie = "Pie", + listTable2_Accent3 = "ListTable2_Accent3", /** - * Block arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - blockArc = "BlockArc", + listTable2_Accent4 = "ListTable2_Accent4", /** - * Donut geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - donut = "Donut", + listTable2_Accent5 = "ListTable2_Accent5", /** - * No smoking geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - noSmoking = "NoSmoking", + listTable2_Accent6 = "ListTable2_Accent6", /** - * Right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightArrow = "RightArrow", + listTable3 = "ListTable3", /** - * Left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftArrow = "LeftArrow", + listTable3_Accent1 = "ListTable3_Accent1", /** - * Up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upArrow = "UpArrow", + listTable3_Accent2 = "ListTable3_Accent2", /** - * Down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - downArrow = "DownArrow", + listTable3_Accent3 = "ListTable3_Accent3", /** - * Striped right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - stripedRightArrow = "StripedRightArrow", + listTable3_Accent4 = "ListTable3_Accent4", /** - * Notched right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - notchedRightArrow = "NotchedRightArrow", + listTable3_Accent5 = "ListTable3_Accent5", /** - * Bent up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bentUpArrow = "BentUpArrow", + listTable3_Accent6 = "ListTable3_Accent6", /** - * Left-right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightArrow = "LeftRightArrow", + listTable4 = "ListTable4", /** - * Up-down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upDownArrow = "UpDownArrow", + listTable4_Accent1 = "ListTable4_Accent1", /** - * Left-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftUpArrow = "LeftUpArrow", + listTable4_Accent2 = "ListTable4_Accent2", /** - * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightUpArrow = "LeftRightUpArrow", + listTable4_Accent3 = "ListTable4_Accent3", /** - * Quad arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - quadArrow = "QuadArrow", + listTable4_Accent4 = "ListTable4_Accent4", /** - * Left arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftArrowCallout = "LeftArrowCallout", + listTable4_Accent5 = "ListTable4_Accent5", /** - * Right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightArrowCallout = "RightArrowCallout", + listTable4_Accent6 = "ListTable4_Accent6", /** - * Up arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upArrowCallout = "UpArrowCallout", + listTable5Dark = "ListTable5Dark", /** - * Down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - downArrowCallout = "DownArrowCallout", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** - * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightArrowCallout = "LeftRightArrowCallout", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** - * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upDownArrowCallout = "UpDownArrowCallout", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** - * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - quadArrowCallout = "QuadArrowCallout", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** - * Bent arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bentArrow = "BentArrow", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** - * U-turn arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - uturnArrow = "UturnArrow", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** - * Circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - circularArrow = "CircularArrow", + listTable6Colorful = "ListTable6Colorful", /** - * Left circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftCircularArrow = "LeftCircularArrow", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** - * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightCircularArrow = "LeftRightCircularArrow", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** - * Curved right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedRightArrow = "CurvedRightArrow", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** - * Curved left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedLeftArrow = "CurvedLeftArrow", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** - * Curved up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedUpArrow = "CurvedUpArrow", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** - * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedDownArrow = "CurvedDownArrow", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** - * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - swooshArrow = "SwooshArrow", + listTable7Colorful = "ListTable7Colorful", /** - * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - cube = "Cube", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** - * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - can = "Can", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** - * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lightningBolt = "LightningBolt", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** - * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heart = "Heart", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** - * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - sun = "Sun", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** - * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - moon = "Moon", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** - * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - smileyFace = "SmileyFace", + string = "String", /** - * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - irregularSeal1 = "IrregularSeal1", + number = "Number", /** - * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - irregularSeal2 = "IrregularSeal2", + date = "Date", /** - * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - foldedCorner = "FoldedCorner", + boolean = "Boolean", + } + /** + * Specifies the type of item to print from a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutItem { /** - * Bevel geometric shape. + * Represents printing the document content. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bevel = "Bevel", + documentContent = "DocumentContent", /** - * Frame geometric shape. + * Represents printing the document properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - frame = "Frame", + properties = "Properties", /** - * Half frame geometric shape. + * Represents printing the comments. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - halfFrame = "HalfFrame", + comments = "Comments", /** - * Corner geometric shape. + * Represents printing the markup. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - corner = "Corner", + markup = "Markup", /** - * Diagonal stripe geometric shape. + * Represents printing the styles. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - diagonalStripe = "DiagonalStripe", + styles = "Styles", /** - * Chord geometric shape. + * Represents printing the AutoText entries. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chord = "Chord", + autoTextEntries = "AutoTextEntries", /** - * Arc geometric shape. + * Represents printing the key assignments. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - arc = "Arc", + keyAssignments = "KeyAssignments", /** - * Left bracket geometric shape. + * Represents printing the envelope. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftBracket = "LeftBracket", + envelope = "Envelope", /** - * Right bracket geometric shape. + * Represents printing the document with markup. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightBracket = "RightBracket", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies which pages to print based on odd or even page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutPages { /** - * Left brace geometric shape. + * Represents printing all pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftBrace = "LeftBrace", + all = "All", /** - * Right brace geometric shape. + * Represents printing only odd-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightBrace = "RightBrace", + oddOnly = "OddOnly", /** - * Bracket pair geometric shape. + * Represents printing only even-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bracketPair = "BracketPair", + evenOnly = "EvenOnly", + } + /** + * Specifies the range of content to print from a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutRange { /** - * Brace pair geometric shape. + * Represents printing the entire document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bracePair = "BracePair", + allDocument = "AllDocument", /** - * Callout 1 geometric shape. + * Represents printing the current selection. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout1 = "Callout1", + selection = "Selection", /** - * Callout 2 geometric shape. + * Represents printing the current page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout2 = "Callout2", + currentPage = "CurrentPage", /** - * Callout 3 geometric shape. + * Represents printing a range from one page to another. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout3 = "Callout3", + fromTo = "FromTo", /** - * Accent callout 1 geometric shape. + * Represents printing specific ranges of pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout1 = "AccentCallout1", + rangeOfPages = "RangeOfPages", + } + /** + * Specifies the export format for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportFormat { /** - * Accent callout 2 geometric shape. + * PDF export format. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout2 = "AccentCallout2", + pdf = "Pdf", /** - * Accent callout 3 geometric shape. + * XPS export format. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout3 = "AccentCallout3", + xps = "Xps", + } + /** + * Specifies the export item type for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportItem { /** - * Border callout 1 geometric shape. + * Exports document content only. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout1 = "BorderCallout1", + documentContent = "DocumentContent", /** - * Border callout 2 geometric shape. + * Exports document with markup (annotations). * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout2 = "BorderCallout2", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies the optimization target for document export. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportOptimizeFor { /** - * Border callout 3 geometric shape. + * Optimizes for print. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout3 = "BorderCallout3", + print = "Print", /** - * Accent border callout 1 geometric shape. + * Optimizes for on-screen display. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout1 = "AccentBorderCallout1", + onScreen = "OnScreen", + } + /** + * Specifies the range to export from a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportRange { /** - * Accent border callout 2 geometric shape. + * Exports the entire document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout2 = "AccentBorderCallout2", + allDocument = "AllDocument", /** - * Accent border callout 3 geometric shape. + * Exports the current selection. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout3 = "AccentBorderCallout3", + selection = "Selection", /** - * Wedge rectangle callout geometric shape. + * Exports the current page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeRectCallout = "WedgeRectCallout", + currentPage = "CurrentPage", /** - * Wedge rounded rectangle callout geometric shape. + * Exports a specific range of pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeRRectCallout = "WedgeRRectCallout", + fromTo = "FromTo", + } + /** + * Specifies the type of bookmarks to create during export. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportCreateBookmarks { /** - * Wedge ellipse callout geometric shape. + * Do not create bookmarks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeEllipseCallout = "WedgeEllipseCallout", + none = "None", /** - * Cloud callout geometric shape. + * Creates bookmarks from headings. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cloudCallout = "CloudCallout", + headings = "Headings", /** - * Cloud geometric shape. + * Creates bookmarks from Word bookmarks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cloud = "Cloud", + wordBookmarks = "WordBookmarks", + } + /** + * Specifies the source of formatting to use during document operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum UseFormattingFrom { /** - * Ribbon geometric shape. + * Represents using formatting from the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ribbon = "Ribbon", + current = "Current", /** - * Ribbon 2 geometric shape. + * Represents using formatting from the selected document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ribbon2 = "Ribbon2", + selected = "Selected", /** - * Ellipse ribbon geometric shape. + * Represents prompting the user for formatting preferences. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ellipseRibbon = "EllipseRibbon", + prompt = "Prompt", + } + /** + * Indicates the auto macros that can run automatically in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoMacro { /** - * Ellipse ribbon 2 geometric shape. + * Indicates that the macro runs automatically when Word starts. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ellipseRibbon2 = "EllipseRibbon2", + startWord = "StartWord", /** - * Left-right ribbon geometric shape. + * Indicates that the macro runs automatically when a new document is created. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRightRibbon = "LeftRightRibbon", + new = "New", /** - * Vertical scroll geometric shape. + * Indicates that the macro runs automatically when the document is opened. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalScroll = "VerticalScroll", + open = "Open", /** - * Horizontal scroll geometric shape. + * Indicates that the macro runs automatically when the document is closed. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalScroll = "HorizontalScroll", + close = "Close", /** - * Wave geometric shape. + * Indicates that the macro runs automatically when the document is saved. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + exit = "Exit", /** - * Double wave geometric shape. + * Indicates that the macro runs automatically when the document is synchronized. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleWave = "DoubleWave", + sync = "Sync", + } + /** + * Document statistic types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Statistic { /** - * Plus geometric shape. + * Words in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plus = "Plus", + words = "Words", /** - * Flow chart process geometric shape. + * Lines in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartProcess = "FlowChartProcess", + lines = "Lines", /** - * Flow chart decision geometric shape. + * Pages in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDecision = "FlowChartDecision", + pages = "Pages", /** - * Flow chart input-output geometric shape. + * Characters in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartInputOutput = "FlowChartInputOutput", + characters = "Characters", /** - * Flow chart predefined process geometric shape. + * Paragraphs in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + paragraphs = "Paragraphs", /** - * Flow chart internal storage geometric shape. + * Characters including spaces. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartInternalStorage = "FlowChartInternalStorage", + charactersWithSpaces = "CharactersWithSpaces", /** - * Flow chart document geometric shape. + * Far East (DBCS) characters. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDocument = "FlowChartDocument", + farEastCharacters = "FarEastCharacters", + } + /** + * Specifies the type of document information to remove. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RemoveDocInfoType { /** - * Flow chart multidocument geometric shape. + * Comments in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMultidocument = "FlowChartMultidocument", + comments = "Comments", /** - * Flow chart terminator geometric shape. + * Revisions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartTerminator = "FlowChartTerminator", + revisions = "Revisions", /** - * Flow chart preparation geometric shape. + * Versions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPreparation = "FlowChartPreparation", + versions = "Versions", /** - * Flow chart manual input geometric shape. + * Personal information in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartManualInput = "FlowChartManualInput", + removePersonalInformation = "RemovePersonalInformation", /** - * Flow chart manual operation geometric shape. + * Email header in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartManualOperation = "FlowChartManualOperation", + emailHeader = "EmailHeader", /** - * Flow chart connector geometric shape. + * Routing slip in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartConnector = "FlowChartConnector", + routingSlip = "RoutingSlip", /** - * Flow chart punched card geometric shape. + * Send for review information in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPunchedCard = "FlowChartPunchedCard", + sendForReview = "SendForReview", /** - * Flow chart punched tape geometric shape. + * Document properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPunchedTape = "FlowChartPunchedTape", + documentProperties = "DocumentProperties", /** - * Flow chart summing junction geometric shape. + * Template information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartSummingJunction = "FlowChartSummingJunction", + template = "Template", /** - * Flow chart OR geometric shape. + * Document workspace properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOr = "FlowChartOr", + documentWorkspace = "DocumentWorkspace", /** - * Flow chart collate geometric shape. + * Ink annotations in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartCollate = "FlowChartCollate", + inkAnnotations = "InkAnnotations", /** - * Flow chart sort geometric shape. + * Document server properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartSort = "FlowChartSort", + documentServerProperties = "DocumentServerProperties", /** - * Flow chart extract geometric shape. + * Document management policy. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartExtract = "FlowChartExtract", + documentManagementPolicy = "DocumentManagementPolicy", /** - * Flow chart merge geometric shape. + * Content type information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMerge = "FlowChartMerge", + contentType = "ContentType", /** - * Flow chart offline storage geometric shape. + * Taskpane web extensions. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + taskpaneWebExtensions = "TaskpaneWebExtensions", /** - * Flow chart online storage geometric shape. + * At mentions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + atMentions = "AtMentions", /** - * Flow chart magnetic tape geometric shape. + * Document tasks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticTape = "FlowChartMagneticTape", + documentTasks = "DocumentTasks", /** - * Flow chart magnetic disk geometric shape. + * Document intelligence information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + documentIntelligence = "DocumentIntelligence", /** - * Flow chart magnetic drum geometric shape. + * Comment reactions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + commentReactions = "CommentReactions", /** - * Flow chart display geometric shape. + * All document information types. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDisplay = "FlowChartDisplay", + all = "All", + } + /** + * Specifies the version type for document check-in operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CheckInVersionType { /** - * Flow chart delay geometric shape. + * Represents a minor version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDelay = "FlowChartDelay", + minor = "Minor", /** - * Flow chart alternate process geometric shape. + * Represents a major version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + major = "Major", /** - * Flow chart off-page connector geometric shape. + * Represents an overwrite version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + overwrite = "Overwrite", + } + /** + * Specifies the target document for merge operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MergeTarget { /** - * Action button blank geometric shape. + * Represents merging into the selected document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBlank = "ActionButtonBlank", + selected = "Selected", /** - * Action button home geometric shape. + * Represents merging into the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonHome = "ActionButtonHome", + current = "Current", /** - * Action button help geometric shape. + * Represents merging into a new document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonHelp = "ActionButtonHelp", + new = "New", + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkSpelling} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentCheckSpellingOptions { /** - * Action button information geometric shape. + * If provided, specifies whether to always suggest spelling corrections. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonInformation = "ActionButtonInformation", + alwaysSuggest?: boolean; /** - * Action button forward next geometric shape. + * If provided, specifies the custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonForwardNext = "ActionButtonForwardNext", + customDictionary?: string; /** - * Action button back previous geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + customDictionary10?: string; /** - * Action button end geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonEnd = "ActionButtonEnd", + customDictionary2?: string; /** - * Action button beginning geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBeginning = "ActionButtonBeginning", + customDictionary3?: string; /** - * Action button return geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonReturn = "ActionButtonReturn", + customDictionary4?: string; /** - * Action button document geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonDocument = "ActionButtonDocument", + customDictionary5?: string; /** - * Action button sound geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonSound = "ActionButtonSound", + customDictionary6?: string; /** - * Action button movie geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonMovie = "ActionButtonMovie", + customDictionary7?: string; /** - * Gear 6 geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gear6 = "Gear6", + customDictionary8?: string; /** - * Gear 9 geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gear9 = "Gear9", + customDictionary9?: string; /** - * Funnel geometric shape. + * If provided, specifies whether to ignore uppercase words during spell checking. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - funnel = "Funnel", + ignoreUppercase?: boolean; + } + /** + * Provides configuration options for the {@link Word.Document | Document.range} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentRangeOptions { /** - * Math plus geometric shape. + * If provided, specifies the ending character position. The default value is the end of the document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathPlus = "MathPlus", + end?: number; /** - * Math minus geometric shape. + * If provided, specifies the starting character position. The default value is `0`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathMinus = "MathMinus", + start?: number; + } + /** + * Represents the options for the {@link Word.Selection | Selection.goTo} and {@link Word.Document| Document.goTo} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface GoToOptions { /** - * Math multiply geometric shape. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathMultiply = "MathMultiply", + count?: number; /** - * Math divide geometric shape. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathDivide = "MathDivide", + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * Math equal geometric shape. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathEqual = "MathEqual", + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; /** - * Math not equal geometric shape. + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathNotEqual = "MathNotEqual", + name?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.printOut} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentPrintOutOptions { /** - * Corner tabs geometric shape. + * If provided, specifies the printer name. The default value is an empty string. This argument is available only in Microsoft Office Macintosh Edition. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cornerTabs = "CornerTabs", + activePrinterMacGX?: string; /** - * Square tabs geometric shape. + * If provided, specifies whether to append to an existing file. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - squareTabs = "SquareTabs", + append?: boolean; /** - * Plaque tabs geometric shape. + * If provided, specifies whether to print in the background. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plaqueTabs = "PlaqueTabs", + background?: boolean; /** - * Chart X geometric shape. + * If provided, specifies whether to collate pages. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chartX = "ChartX", + collate?: boolean; /** - * Chart star geometric shape. + * If provided, specifies the number of copies to print. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chartStar = "ChartStar", + copies?: number; /** - * Chart plus geometric shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - chartPlus = "ChartPlus", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeFillType { - /** - * No fill. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - noFill = "NoFill", - /** - * Solid fill. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - solid = "Solid", - /** - * Gradient fill. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gradient = "Gradient", + from?: number; /** - * Pattern fill. + * If provided, specifies the item to print. The default value is `PrintOutItem.documentContent`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pattern = "Pattern", + item?: Word.PrintOutItem | "DocumentContent" | "Properties" | "Comments" | "Markup" | "Styles" | "AutoTextEntries" | "KeyAssignments" | "Envelope" | "DocumentWithMarkup"; /** - * Picture fill. + * If provided, specifies whether to manually duplex print. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + manualDuplexPrint?: boolean; /** - * Texture fill. + * If provided, specifies the name of the output file. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture = "Texture", + outputFileName?: string; /** - * Mixed fill. + * If provided, specifies the page order. The default value is `PrintOutPages.allPages`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", - } - /** - * Specifies the vertical alignment for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextVerticalAlignment { + pageType?: Word.PrintOutPages | "All" | "OddOnly" | "EvenOnly"; /** - * Anchor the text at the top of the bounding rectangle. + * If provided, specifies specific pages to print. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + pages?: string; /** - * Anchor the text at the middle of the bounding rectangle. + * If provided, specifies whether to print to file. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - middle = "Middle", + printToFile?: boolean; /** - * Anchor the text at the bottom of the bounding rectangle. + * If provided, specifies the zoom column setting. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", - } - /** - * Specifies the orientation for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextOrientation { + printZoomColumn?: number; /** - * No orientation, such as in a new geometric shape. + * If provided, specifies the paper height for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is `0` (use original height). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + printZoomPaperHeight?: number; /** - * Horizontal text. + * If provided, specifies the paper width for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is `0` (use original width). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontal = "Horizontal", + printZoomPaperWidth?: number; /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * If provided, specifies the zoom row setting. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eastAsianVertical = "EastAsianVertical", + printZoomRow?: number; /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * If provided, specifies the range to print. The default value is `allDocument`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vertical270 = "Vertical270", + range?: Word.PrintOutRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo" | "RangeOfPages"; /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vertical = "Vertical", + to?: number; + } + /** + * Provides configuration options for the {@link Word.Document | Document.exportAsFixedFormat} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentExportAsFixedFormatOptions { /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + bitmapMissingFonts?: boolean; /** - * A combination of automatic orientation is used. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", - } - /** - * Determines the type of automatic sizing allowed. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeAutoSize { + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * No autosizing. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + documentStructureTags?: boolean; /** - * The text is adjusted to fit the shape. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textToFitShape = "TextToFitShape", + fixedFormatExtensionClassPointer?: any; /** - * The shape is adjusted to fit the text. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeToFitText = "ShapeToFitText", + from?: number; /** - * A combination of automatic sizing schemes are used. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", - } - /** - * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapType { + includeDocProps?: boolean; /** - * Places the shape in line with text. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inline = "Inline", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Wraps text squarely around the shape. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - square = "Square", + keepInformationRightsManagement?: boolean; /** - * Wraps text close to the shape. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tight = "Tight", + openAfterExport?: boolean; /** - * Wraps text around and through the shape. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - through = "Through", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Places text above and below the shape. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topBottom = "TopBottom", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; /** - * Places shape behind text. + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - behind = "Behind", + to?: number; /** - * Places shape in front of text. + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - front = "Front", + useIso19005_1?: boolean; } /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * Provides configuration options for the {@link Word.Document | Document.followHyperlink} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeTextWrapSide { + export interface DocumentFollowHyperlinkOptions { /** - * Has no wrap side property, such as those for inline shapes. + * If provided, specifies whether to add the link to the browsing history. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + addHistory?: boolean; /** - * Both left and right sides of the shape. + * If provided, specifies the hyperlink address to follow. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - both = "Both", + address?: string; /** - * Left side of the shape only. + * If provided, specifies additional information to pass with the request. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + extraInfo?: string; /** - * Right side of the shape only. + * If provided, specifies header information for the HTTP request. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + headerInfo?: string; /** - * Side of the shape that's farther from the respective page margin. + * If provided, specifies the HTTP method to use for the request. The default value is "GET". + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - largest = "Largest", - } - /** - * Specifies the scale size type of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleType { + httpMethod?: string; /** - * Scale from current size of the shape. + * If provided, specifies whether to open the link in a new window. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - currentSize = "CurrentSize", + newWindow?: boolean; /** - * Scale from original size of the shape. It only works for pictures. + * If provided, specifies the sub-address within the document. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - originalSize = "OriginalSize", + subAddress?: string; } /** - * Specifies which part of the shape retains its position when the shape is scaled. + * Provides configuration options for the {@link Word.Document | Document.countNumberedItems} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeScaleFrom { - /** - * Scale from the top left corner of the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - scaleFromTopLeft = "ScaleFromTopLeft", + export interface DocumentCountNumberedItemsOptions { /** - * Scale from the center of the shape. + * If provided, specifies the level of numbering to count. If omitted, all levels are counted. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleFromMiddle = "ScaleFromMiddle", + level?: number; /** - * Scale from the bottom right corner of the shape. + * If provided, specifies the type of numbered items to count. The default value is `allNumbers`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleFromBottomRight = "ScaleFromBottomRight", + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; } /** - * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * Provides configuration options for the {@link Word.Document | Document.merge} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FrameSizeRule { + export interface DocumentMergeOptions { /** - * The height or width is set according to the height or width of the item in the frame. + * If provided, specifies whether to add the merged document to recent files. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + addToRecentFiles?: boolean; /** - * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. + * If provided, specifies whether to detect format changes during the merge. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + detectFormatChanges?: boolean; /** - * The height or width is set to an exact value specified by the `height` property or `width` property. + * If provided, specifies the target of the merge operation. The default value is `current`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exact = "Exact", + mergeTarget?: Word.MergeTarget | "Selected" | "Current" | "New"; + /** + * If provided, specifies the source of formatting to use in the merge. The default value is `current`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useFormattingFrom?: Word.UseFormattingFrom | "Current" | "Selected" | "Prompt"; } /** - * Specifies the border style for an object. + * Provides configuration options for the {@link Word.Document | Document.sendForReview} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BorderLineStyle { + export interface DocumentSendForReviewOptions { /** - * No line style. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + includeAttachment?: boolean; /** - * Single line style. + * If provided, specifies the recipients of the review request. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + recipients?: string; /** - * Dotted line style. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dot = "Dot", + showMessage?: boolean; /** - * Dashed line style with small gaps. + * If provided, specifies the subject of the review email. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashSmallGap = "DashSmallGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.replyWithChanges} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentReplyWithChangesOptions { /** - * Dashed line style with large gaps. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLargeGap = "DashLargeGap", + includeAttachment?: boolean; /** - * Dash-dot line style. + * If provided, specifies the recipients of the reply. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + recipients?: string; /** - * Dash-dot-dot line style. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + showMessage?: boolean; /** - * Double line style. + * If provided, specifies the subject of the reply email. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.endReview} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentEndReviewOptions { /** - * Triple line style. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triple = "Triple", + includeAttachment?: boolean; /** - * Thin-thick line style with small gaps. + * If provided, specifies the recipients to notify when ending the review. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickSmallGap = "ThinThickSmallGap", + recipients?: string; /** - * Thick-thin line style with small gaps. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinSmallGap = "ThickThinSmallGap", + showMessage?: boolean; /** - * Thin-thick-thin line style with small gaps. + * If provided, specifies the subject of the notification email. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinSmallGap = "ThinThickThinSmallGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.sendFaxOverInternet} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentSendFaxOverInternetOptions { /** - * Thin-thick line style with medium gaps. + * If provided, specifies the recipients of the fax. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickMedGap = "ThinThickMedGap", + recipients?: string; /** - * Thick-thin line style with medium gaps. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinMedGap = "ThickThinMedGap", + showMessage?: boolean; /** - * Thin-thick-thin line style with medium gaps. + * If provided, specifies the subject of the fax. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinMedGap = "ThinThickThinMedGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.protect} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentProtectOptions { /** - * Thin-thick line style with large gaps. + * If provided, specifies whether to enforce style lock restrictions. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickLargeGap = "ThinThickLargeGap", + enforceStyleLock?: boolean; /** - * Thick-thin line style with large gaps. + * If provided, specifies whether to reset form fields when protecting the document. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinLargeGap = "ThickThinLargeGap", + noReset?: boolean; /** - * Thin-thick-thin line style with large gaps. + * If provided, specifies the password to apply for document protection. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinLargeGap = "ThinThickThinLargeGap", + password?: string; /** - * Single wavy line style. + * If provided, specifies whether to use Information Rights Management (IRM). The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleWavy = "SingleWavy", + useInformationRightsManagement?: boolean; + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkInWithVersion} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentCheckInWithVersionOptions { /** - * Double wavy line style. + * If provided, specifies a comment for the check-in operation. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleWavy = "DoubleWavy", + comment?: string; /** - * Dash-dot stroked line style. + * If provided, specifies whether to make the document public after check-in. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotStroked = "DashDotStroked", + makePublic?: boolean; /** - * Embossed 3D line style. + * If provided, specifies whether to save changes before checking in. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss3D = "Emboss3D", + saveChanges?: boolean; /** - * Engraved 3D line style. + * If provided, specifies the version type for the check-in. The default value is `minorVersion`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave3D = "Engrave3D", + versionType?: Word.CheckInVersionType | "Minor" | "Major" | "Overwrite"; + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkIn} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentCheckInOptions { /** - * Outset line style. + * If provided, specifies a comment for the check-in operation. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outset = "Outset", + comment?: string; /** - * Inset line style. + * If provided, specifies whether to make the document public after check-in. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inset = "Inset", + makePublic?: boolean; + /** + * If provided, specifies whether to save changes before checking in. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + saveChanges?: boolean; } /** - * Specifies the width of an object's border. + * Represents the options for exporting a document as a fixed format (PDF or XPS) using the {@link Word.Document | Document.exportAsFixedFormat2} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineWidth { + export interface DocumentExportAsFixedFormat2Options { /** - * Represents a line width of 0.25 points. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt025 = "Pt025", + bitmapMissingFonts?: boolean; /** - * Represents a line width of 0.50 points. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt050 = "Pt050", + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * Represents a line width of 0.75 points. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt075 = "Pt075", + documentStructureTags?: boolean; /** - * Represents a line width of 1.00 points. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt100 = "Pt100", + fixedFormatExtClassPtr?: any; /** - * Represents a line width of 1.50 points. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt150 = "Pt150", + from?: number; /** - * Represents a line width of 2.25 points. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt225 = "Pt225", + includeDocProps?: boolean; /** - * Represents a line width of 3.00 points. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt300 = "Pt300", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Represents a line width of 4.50 points. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt450 = "Pt450", + keepInformationRightsManagement?: boolean; /** - * Represents a line width of 6.00 points. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt600 = "Pt600", - } - /** - * Specifies the graphical page border setting of a page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageBorderArt { + openAfterExport?: boolean; /** - * Represents a border with apple design. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - apples = "Apples", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Represents a border with maple muffin design. + * If provided, specifies whether to optimize for image quality in the exported file. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapleMuffins = "MapleMuffins", + optimizeForImageQuality?: boolean; /** - * Represents a border with cake slice design. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cakeSlice = "CakeSlice", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; /** - * Represents a border with candy corn design. + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - candyCorn = "CandyCorn", + to?: number; /** - * Represents a border with ice cream cone design. + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iceCreamCones = "IceCreamCones", + useIso19005_1?: boolean; + } + /** + * Represents the options for exporting a document as a fixed format (PDF or XPS) with improved tagging using the {@link Word.Document | Document.exportAsFixedFormat3} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentExportAsFixedFormat3Options { /** - * Represents a border with champagne bottle design. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - champagneBottle = "ChampagneBottle", + bitmapMissingFonts?: boolean; /** - * Represents a border with party glass design. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - partyGlass = "PartyGlass", + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * Represents a border with Christmas tree design. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - christmasTree = "ChristmasTree", + documentStructureTags?: boolean; /** - * Represents a border with trees design. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trees = "Trees", + fixedFormatExtClassPtr?: any; /** - * Represents a border with palm trees in color. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - palmsColor = "PalmsColor", + from?: number; /** - * Represents a border with three-color balloons design. + * If provided, specifies to improve export tagging for better accessibility. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloons3Colors = "Balloons3Colors", + improveExportTagging?: boolean; /** - * Represents a border with hot air balloons design. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloonsHotAir = "BalloonsHotAir", + includeDocProps?: boolean; /** - * Represents a border with party favor design. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - partyFavor = "PartyFavor", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Represents a border with confetti streamers design. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiStreamers = "ConfettiStreamers", + keepInformationRightsManagement?: boolean; /** - * Represents a border with hearts design. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hearts = "Hearts", + openAfterExport?: boolean; /** - * Represents a border with heart balloon design. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heartBalloon = "HeartBalloon", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Represents a border with 3D stars design. + * If provided, specifies whether to optimize for image quality in the exported file. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stars3D = "Stars3D", + optimizeForImageQuality?: boolean; /** - * Represents a border with shadowed stars design. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsShadowed = "StarsShadowed", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; /** - * Represents a border with stars design. + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stars = "Stars", + to?: number; /** - * Represents a border with sun design. + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sun = "Sun", + useIso19005_1?: boolean; + } + /** + * Specifies the type of document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentType { /** - * Represents a border with Earth design (variant 2). + * Represents a standard document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earth2 = "Earth2", + document = "Document", /** - * Represents a border with Earth design (variant 1). + * Represents a document template. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earth1 = "Earth1", + template = "Template", /** - * Represents a border with people wearing hats design. + * Represents a frameset document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peopleHats = "PeopleHats", + frameset = "Frameset", + } + /** + * Specifies the kind or purpose of a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentKind { /** - * Represents a border with sombrero design. + * Represents a document with no specified kind. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sombrero = "Sombrero", + notSpecified = "NotSpecified", /** - * Represents a border with pencils design. + * Represents a letter document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pencils = "Pencils", + letter = "Letter", /** - * Represents a border with packages design. + * Represents an email document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - packages = "Packages", + email = "Email", + } + /** + * Represents the file format to use when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FileSaveFormat { /** - * Represents a border with clocks design. + * Represents Microsoft Office Word 97 - 2003 binary file format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clocks = "Clocks", + document = "Document", /** - * Represents a border with firecrackers design. + * Represents Word template format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firecrackers = "Firecrackers", + template = "Template", /** - * Represents a border with rings design. + * Represents Microsoft Windows text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rings = "Rings", + text = "Text", /** - * Represents a border with map pins design. + * Represents Windows text format with line breaks preserved. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapPins = "MapPins", + textLineBreaks = "TextLineBreaks", /** - * Represents a border with confetti design. + * Represents Microsoft DOS text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confetti = "Confetti", + dosText = "DosText", /** - * Represents a border with butterfly creatures design. + * Represents Microsoft DOS text with line breaks preserved. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesButterfly = "CreaturesButterfly", + dosTextLineBreaks = "DosTextLineBreaks", /** - * Represents a border with ladybug creatures design. + * Represents Rich Text Format (RTF). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesLadyBug = "CreaturesLadyBug", + rtf = "Rtf", /** - * Represents a border with fish creatures design. + * Represents Unicode text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesFish = "CreaturesFish", + unicodeText = "UnicodeText", /** - * Represents a border with birds in flight design. + * Represents standard HTML format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - birdsFlight = "BirdsFlight", + html = "Html", /** - * Represents a border with scared cat design. + * Represents Web archive format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaredCat = "ScaredCat", + webArchive = "WebArchive", /** - * Represents a border with bats design. + * Represents filtered HTML format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bats = "Bats", + filteredHtml = "FilteredHtml", /** - * Represents a border with roses flowers design. + * Represents Extensible Markup Language (XML) format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersRoses = "FlowersRoses", + xml = "Xml", /** - * Represents a border with red rose flowers design. + * Represents XML document format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersRedRose = "FlowersRedRose", + xmlDocument = "XmlDocument", /** - * Represents a border with poinsettias flowers design. + * Represents XML document format with macros enabled. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - poinsettias = "Poinsettias", + xmlDocumentMacroEnabled = "XmlDocumentMacroEnabled", /** - * Represents a border with holly design. + * Represents XML template format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - holly = "Holly", + xmlTemplate = "XmlTemplate", /** - * Represents a border with tiny flowers design. + * Represents XML template format with macros enabled. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersTiny = "FlowersTiny", + xmlTemplateMacroEnabled = "XmlTemplateMacroEnabled", /** - * Represents a border with pansy flowers design. + * Represents Word default document file format. For Word, this is the DOCX format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersPansy = "FlowersPansy", + documentDefault = "DocumentDefault", /** - * Represents a border with modern 2 flowers design. + * Represents PDF format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersModern2 = "FlowersModern2", + pdf = "Pdf", /** - * Represents a border with modern 1 flowers design. + * Represents XPS format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersModern1 = "FlowersModern1", + xps = "Xps", /** - * Represents a border with white flowers design. + * Represents Open XML file format saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteFlowers = "WhiteFlowers", + flatXml = "FlatXml", /** - * Represents a border with vine design. + * Represents Open XML file format with macros enabled saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vine = "Vine", + flatXmlMacroEnabled = "FlatXmlMacroEnabled", /** - * Represents a border with daisies flowers design. + * Represents Open XML template format saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersDaisies = "FlowersDaisies", + flatXmlTemplate = "FlatXmlTemplate", /** - * Represents a border with block print flowers design. + * Represents Open XML template format with macros enabled saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersBlockPrint = "FlowersBlockPrint", + flatXmlTemplateMacroEnabled = "FlatXmlTemplateMacroEnabled", /** - * Represents a border with colored deco arch design. + * Represents OpenDocument Text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoArchColor = "DecoArchColor", + openDocumentText = "OpenDocumentText", /** - * Represents a border with fans design. + * Represents Strict Open XML document format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fans = "Fans", + strictOpenXmlDocument = "StrictOpenXmlDocument", + } + /** + * Specifies the protection type for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ProtectionType { /** - * Represents a border with film design. + * No protection is applied to the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - film = "Film", + noProtection = "NoProtection", /** - * Represents a border with lightning design (variant 1). + * Only revisions are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightning1 = "Lightning1", + allowOnlyRevisions = "AllowOnlyRevisions", /** - * Represents a border with compass design. + * Only comments are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compass = "Compass", + allowOnlyComments = "AllowOnlyComments", /** - * Represents a border with double D design. + * Only form fields are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleD = "DoubleD", + allowOnlyFormFields = "AllowOnlyFormFields", /** - * Represents a border with classical wave design. + * Only reading is allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicalWave = "ClassicalWave", + allowOnlyReading = "AllowOnlyReading", + } + /** + * Represents how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineEndingType { /** - * Represents a border with shadowed squares design. + * Represents carriage return and line feed (Windows standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadowedSquares = "ShadowedSquares", + crlf = "Crlf", /** - * Represents a border with twisted lines design (variant 1). + * Represents carriage return only (Mac classic standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twistedLines1 = "TwistedLines1", + crOnly = "CrOnly", /** - * Represents a border with waveline design. + * Represents line feed only (Unix/Linux standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waveline = "Waveline", + lfOnly = "LfOnly", /** - * Represents a border with quadrants design. + * Represents line feed and carriage return. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quadrants = "Quadrants", + lfcr = "Lfcr", /** - * Represents a border with colored checked bar design. + * Represents line separator and paragraph separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarColor = "CheckedBarColor", + lsps = "Lsps", + } + /** + * Specifies the document encoding types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentEncoding { /** - * Represents a border with swirligig design. + * Thai encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swirligig = "Swirligig", + thai = "Thai", /** - * Represents a border with push pin note design (variant 1). + * Japanese Shift Japanese Industrial Standards (Shift JIS) encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pushPinNote1 = "PushPinNote1", + japaneseShiftJis = "JapaneseShiftJis", /** - * Represents a border with push pin note design (variant 2). + * Simplified Chinese Guojia Biaozhun Kuozhan (GBK, which means "National Standard Extended" in Chinese) encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pushPinNote2 = "PushPinNote2", + simplifiedChineseGbk = "SimplifiedChineseGbk", /** - * Represents a border with pumpkin design (variant 1). + * Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pumpkin1 = "Pumpkin1", + korean = "Korean", /** - * Represents a border with black eggs design. + * Traditional Chinese Big5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eggsBlack = "EggsBlack", + traditionalChineseBig5 = "TraditionalChineseBig5", /** - * Represents a border with cup design. + * Unicode Little Endian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cup = "Cup", + unicodeLittleEndian = "UnicodeLittleEndian", /** - * Represents a border with gray heart design. + * Unicode Big Endian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heartGray = "HeartGray", + unicodeBigEndian = "UnicodeBigEndian", /** - * Represents a border with gingerbread man design. + * Central European encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gingerbreadMan = "GingerbreadMan", + centralEuropean = "CentralEuropean", /** - * Represents a border with baby pacifier design. + * Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - babyPacifier = "BabyPacifier", + cyrillic = "Cyrillic", /** - * Represents a border with baby rattle design. + * Western encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - babyRattle = "BabyRattle", + western = "Western", /** - * Represents a border with cabins design. + * Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cabins = "Cabins", + greek = "Greek", /** - * Represents a border with funky house design. + * Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - houseFunky = "HouseFunky", + turkish = "Turkish", /** - * Represents a border with black stars design. + * Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsBlack = "StarsBlack", + hebrew = "Hebrew", /** - * Represents a border with snowflakes design. + * Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - snowflakes = "Snowflakes", + arabic = "Arabic", /** - * Represents a border with fancy snowflake design. + * Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - snowflakeFancy = "SnowflakeFancy", + baltic = "Baltic", /** - * Represents a border with skyrocket design. + * Vietnamese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - skyrocket = "Skyrocket", + vietnamese = "Vietnamese", /** - * Represents a border with Seattle design. + * Auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seattle = "Seattle", + autoDetect = "AutoDetect", /** - * Represents a border with music notes design. + * Japanese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - musicNotes = "MusicNotes", + japaneseAutoDetect = "JapaneseAutoDetect", /** - * Represents a border with black palms design. + * Simplified Chinese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - palmsBlack = "PalmsBlack", + simplifiedChineseAutoDetect = "SimplifiedChineseAutoDetect", /** - * Represents a border with maple leaf design. + * Korean auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapleLeaf = "MapleLeaf", + koreanAutoDetect = "KoreanAutoDetect", /** - * Represents a border with paper clips design. + * Traditional Chinese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperClips = "PaperClips", + traditionalChineseAutoDetect = "TraditionalChineseAutoDetect", /** - * Represents a border with shorebird tracks design. + * Cyrillic auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shorebirdTracks = "ShorebirdTracks", + cyrillicAutoDetect = "CyrillicAutoDetect", /** - * Represents a border with people design. + * Greek auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - people = "People", + greekAutoDetect = "GreekAutoDetect", /** - * Represents a border with people waving design. + * Arabic auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peopleWaving = "PeopleWaving", + arabicAutoDetect = "ArabicAutoDetect", /** - * Represents a border with eclipsing squares design (variant 2). + * ISO 8859-1 Latin1 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eclipsingSquares2 = "EclipsingSquares2", + iso88591Latin1 = "Iso88591Latin1", /** - * Represents a border with hypnotic design. + * ISO 8859-2 Central Europe encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hypnotic = "Hypnotic", + iso88592CentralEurope = "Iso88592CentralEurope", /** - * Represents a border with gray diamonds design. + * ISO 8859-3 Latin3 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diamondsGray = "DiamondsGray", + iso88593Latin3 = "Iso88593Latin3", /** - * Represents a border with deco arch design. + * ISO 8859-4 Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoArch = "DecoArch", + iso88594Baltic = "Iso88594Baltic", /** - * Represents a border with deco blocks design. + * ISO 8859-5 Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoBlocks = "DecoBlocks", + iso88595Cyrillic = "Iso88595Cyrillic", /** - * Represents a border with circles and lines design. + * ISO 8859-6 Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesLines = "CirclesLines", + iso88596Arabic = "Iso88596Arabic", /** - * Represents a border with papyrus design. + * ISO 8859-7 Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + iso88597Greek = "Iso88597Greek", /** - * Represents a border with woodwork design. + * ISO 8859-8 Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - woodwork = "Woodwork", + iso88598Hebrew = "Iso88598Hebrew", /** - * Represents a border with weaving braid design. + * ISO 8859-9 Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingBraid = "WeavingBraid", + iso88599Turkish = "Iso88599Turkish", /** - * Represents a border with weaving ribbon design. + * ISO 8859-15 Latin9 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingRibbon = "WeavingRibbon", + iso885915Latin9 = "Iso885915Latin9", /** - * Represents a border with weaving angles design. + * ISO 8859-8 Hebrew logical encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingAngles = "WeavingAngles", + iso88598HebrewLogical = "Iso88598HebrewLogical", /** - * Represents a border with arched scallops design. + * ISO 2022-JP no halfwidth katakana encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - archedScallops = "ArchedScallops", + iso2022JpNoHalfwidthKatakana = "Iso2022JpNoHalfwidthKatakana", /** - * Represents a border with safari design. + * ISO 2022-JP JIS X 0202-1984 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - safari = "Safari", + iso2022JpJisX02021984 = "Iso2022JpJisX02021984", /** - * Represents a border with Celtic knotwork design. + * ISO 2022-JP JIS X 0201-1989 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - celticKnotwork = "CelticKnotwork", + iso2022JpJisX02011989 = "Iso2022JpJisX02011989", /** - * Represents a border with crazy maze design. + * ISO 2022-KR encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crazyMaze = "CrazyMaze", + iso2022Kr = "Iso2022Kr", /** - * Represents a border with eclipsing squares design (variant 1). + * ISO 2022-CN Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eclipsingSquares1 = "EclipsingSquares1", + iso2022CnTraditionalChinese = "Iso2022CnTraditionalChinese", /** - * Represents a border with birds design. + * ISO 2022-CN Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - birds = "Birds", + iso2022CnSimplifiedChinese = "Iso2022CnSimplifiedChinese", /** - * Represents a border with teacup and flowers design. + * Mac Roman encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersTeacup = "FlowersTeacup", + macRoman = "MacRoman", /** - * Represents a border with northwest design. + * Mac Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - northwest = "Northwest", + macJapanese = "MacJapanese", /** - * Represents a border with southwest design. + * Mac Traditional Chinese Big5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - southwest = "Southwest", + macTraditionalChineseBig5 = "MacTraditionalChineseBig5", /** - * Represents a border with tribal design (variant 6). + * Mac Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal6 = "Tribal6", + macKorean = "MacKorean", /** - * Represents a border with tribal design (variant 4). + * Mac Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal4 = "Tribal4", + macArabic = "MacArabic", /** - * Represents a border with tribal design (variant 3). + * Mac Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal3 = "Tribal3", + macHebrew = "MacHebrew", /** - * Represents a border with tribal design (variant 2). + * Mac Greek1 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal2 = "Tribal2", + macGreek1 = "MacGreek1", /** - * Represents a border with tribal design (variant 5). + * Mac Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal5 = "Tribal5", + macCyrillic = "MacCyrillic", /** - * Represents a border with X illusions design. + * Mac Simplified Chinese GB2312 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xillusions = "XIllusions", + macSimplifiedChineseGb2312 = "MacSimplifiedChineseGb2312", /** - * Represents a border with zany triangles design. + * Mac Romania encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zanyTriangles = "ZanyTriangles", + macRomania = "MacRomania", /** - * Represents a border with pyramids design. + * Mac Ukraine encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pyramids = "Pyramids", + macUkraine = "MacUkraine", /** - * Represents a border with pyramids above design. + * Mac Latin2 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pyramidsAbove = "PyramidsAbove", + macLatin2 = "MacLatin2", /** - * Represents a border with gray confetti design. + * Mac Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiGrays = "ConfettiGrays", + macIcelandic = "MacIcelandic", /** - * Represents a border with outline confetti design. + * Mac Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiOutline = "ConfettiOutline", + macTurkish = "MacTurkish", /** - * Represents a border with white confetti design. + * Mac Croatia encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiWhite = "ConfettiWhite", + macCroatia = "MacCroatia", /** - * Represents a border with mosaic design. + * EBCDIC US-Canada encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mosaic = "Mosaic", + ebcdicUsCanada = "EbcdicUsCanada", /** - * Represents a border with lightning design (variant 2). + * EBCDIC International encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightning2 = "Lightning2", + ebcdicInternational = "EbcdicInternational", /** - * Represents a border with heebie jeebies design. + * EBCDIC Multilingual ROECE Latin2 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heebieJeebies = "HeebieJeebies", + ebcdicMultilingualRoeceLatin2 = "EbcdicMultilingualRoeceLatin2", /** - * Represents a border with light bulb design. + * EBCDIC Greek Modern encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightBulb = "LightBulb", + ebcdicGreekModern = "EbcdicGreekModern", /** - * Represents a border with gradient design. + * EBCDIC Turkish Latin5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + ebcdicTurkishLatin5 = "EbcdicTurkishLatin5", /** - * Represents a border with triangle party design. + * EBCDIC Germany encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triangleParty = "TriangleParty", + ebcdicGermany = "EbcdicGermany", /** - * Represents a border with twisted lines design (variant 2). + * EBCDIC Denmark-Norway encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twistedLines2 = "TwistedLines2", + ebcdicDenmarkNorway = "EbcdicDenmarkNorway", /** - * Represents a border with moons design. + * EBCDIC Finland-Sweden encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moons = "Moons", + ebcdicFinlandSweden = "EbcdicFinlandSweden", /** - * Represents a border with ovals design. + * EBCDIC Italy encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ovals = "Ovals", + ebcdicItaly = "EbcdicItaly", /** - * Represents a border with double diamonds design. + * EBCDIC Latin America-Spain encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleDiamonds = "DoubleDiamonds", + ebcdicLatinAmericaSpain = "EbcdicLatinAmericaSpain", /** - * Represents a border with chain link design. + * EBCDIC United Kingdom encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chainLink = "ChainLink", + ebcdicUnitedKingdom = "EbcdicUnitedKingdom", /** - * Represents a border with triangles design. + * EBCDIC Japanese Katakana Extended encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triangles = "Triangles", + ebcdicJapaneseKatakanaExtended = "EbcdicJapaneseKatakanaExtended", /** - * Represents a border with tribal design (variant 1). + * EBCDIC France encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal1 = "Tribal1", + ebcdicFrance = "EbcdicFrance", /** - * Represents a border with marquee toothed design. + * EBCDIC Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marqueeToothed = "MarqueeToothed", + ebcdicArabic = "EbcdicArabic", /** - * Represents a border with sharks teeth design. + * EBCDIC Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sharksTeeth = "SharksTeeth", + ebcdicGreek = "EbcdicGreek", /** - * Represents a border with sawtooth design. + * EBCDIC Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtooth = "Sawtooth", + ebcdicHebrew = "EbcdicHebrew", /** - * Represents a border with gray sawtooth design. + * EBCDIC Korean Extended encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtoothGray = "SawtoothGray", + ebcdicKoreanExtended = "EbcdicKoreanExtended", /** - * Represents a border with postage stamp design. + * EBCDIC Thai encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - postageStamp = "PostageStamp", + ebcdicThai = "EbcdicThai", /** - * Represents a border with weaving strips design. + * EBCDIC Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingStrips = "WeavingStrips", + ebcdicIcelandic = "EbcdicIcelandic", /** - * Represents a border with zigzag design. + * EBCDIC Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + ebcdicTurkish = "EbcdicTurkish", /** - * Represents a border with cross stitch design. + * EBCDIC Russian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossStitch = "CrossStitch", + ebcdicRussian = "EbcdicRussian", /** - * Represents a border with gems design. + * EBCDIC Serbian-Bulgarian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gems = "Gems", + ebcdicSerbianBulgarian = "EbcdicSerbianBulgarian", /** - * Represents a border with circles and rectangles design. + * EBCDIC Japanese Katakana Extended and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesRectangles = "CirclesRectangles", + ebcdicJapaneseKatakanaExtendedAndJapanese = "EbcdicJapaneseKatakanaExtendedAndJapanese", /** - * Represents a border with corner triangles design. + * EBCDIC US-Canada and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cornerTriangles = "CornerTriangles", + ebcdicUsCanadaAndJapanese = "EbcdicUsCanadaAndJapanese", /** - * Represents a border with insects creatures design. + * EBCDIC Korean Extended and Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesInsects = "CreaturesInsects", + ebcdicKoreanExtendedAndKorean = "EbcdicKoreanExtendedAndKorean", /** - * Represents a border with zigzag stitch design. + * EBCDIC Simplified Chinese Extended and Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZagStitch = "ZigZagStitch", + ebcdicSimplifiedChineseExtendedAndSimplifiedChinese = "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese", /** - * Represents a border with checkered design. + * EBCDIC US-Canada and Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkered = "Checkered", + ebcdicUsCanadaAndTraditionalChinese = "EbcdicUsCanadaAndTraditionalChinese", /** - * Represents a border with black checked bar design. + * EBCDIC Japanese Latin Extended and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarBlack = "CheckedBarBlack", + ebcdicJapaneseLatinExtendedAndJapanese = "EbcdicJapaneseLatinExtendedAndJapanese", /** - * Represents a border with marquee design. + * OEM United States encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marquee = "Marquee", + oemUnitedStates = "OemUnitedStates", /** - * Represents a border with basic white dots design. + * OEM Greek 437G encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDots = "BasicWhiteDots", + oemGreek437G = "OemGreek437G", /** - * Represents a border with basic wide midline design. + * OEM Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideMidline = "BasicWideMidline", + oemBaltic = "OemBaltic", /** - * Represents a border with basic wide outline design. + * OEM Multilingual Latin I encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideOutline = "BasicWideOutline", + oemMultilingualLatinI = "OemMultilingualLatinI", /** - * Represents a border with basic wide inline design. + * OEM Multilingual Latin II encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideInline = "BasicWideInline", + oemMultilingualLatinIi = "OemMultilingualLatinIi", /** - * Represents a border with basic thin lines design. + * OEM Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicThinLines = "BasicThinLines", + oemCyrillic = "OemCyrillic", /** - * Represents a border with basic white dashes design. + * OEM Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDashes = "BasicWhiteDashes", + oemTurkish = "OemTurkish", /** - * Represents a border with basic white squares design. + * OEM Portuguese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteSquares = "BasicWhiteSquares", + oemPortuguese = "OemPortuguese", /** - * Represents a border with basic black squares design. + * OEM Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackSquares = "BasicBlackSquares", + oemIcelandic = "OemIcelandic", /** - * Represents a border with basic black dashes design. + * OEM Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDashes = "BasicBlackDashes", + oemHebrew = "OemHebrew", /** - * Represents a border with basic black dots design. + * OEM Canadian French encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDots = "BasicBlackDots", + oemCanadianFrench = "OemCanadianFrench", /** - * Represents a border with top stars design. + * OEM Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsTop = "StarsTop", + oemArabic = "OemArabic", /** - * Represents a border with certificate banner design. + * OEM Nordic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - certificateBanner = "CertificateBanner", + oemNordic = "OemNordic", /** - * Represents a border with handmade design (variant 1). + * OEM Cyrillic II encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade1 = "Handmade1", + oemCyrillicIi = "OemCyrillicIi", /** - * Represents a border with handmade design (variant 2). + * OEM Modern Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade2 = "Handmade2", + oemModernGreek = "OemModernGreek", /** - * Represents a border with torn paper design. + * EUC Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaper = "TornPaper", + eucJapanese = "EucJapanese", /** - * Represents a border with black torn paper design. + * EUC Chinese Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaperBlack = "TornPaperBlack", + eucChineseSimplifiedChinese = "EucChineseSimplifiedChinese", /** - * Represents a border with coupon cutout dashes design. + * EUC Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDashes = "CouponCutoutDashes", + eucKorean = "EucKorean", /** - * Represents a border with coupon cutout dots design. + * EUC Taiwanese Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDots = "CouponCutoutDots", - } - /** - * Specifies the preferred unit of measure to use when measuring the width of an item. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PreferredWidthType { + eucTaiwaneseTraditionalChinese = "EucTaiwaneseTraditionalChinese", /** - * Automatically select the unit of measure to use based on the current selection. + * ISCII Devanagari encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + isciiDevanagari = "IsciiDevanagari", /** - * Measure the current item width using a specified percentage. + * ISCII Bengali encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + isciiBengali = "IsciiBengali", /** - * Measure the current item width using a specified number of points. + * ISCII Tamil encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Represents the reading order of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingOrder { + isciiTamil = "IsciiTamil", /** - * Represents right-to-left reading order. + * ISCII Telugu encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + isciiTelugu = "IsciiTelugu", /** - * Represents left-to-right reading order. + * ISCII Assamese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", - } - /** - * Specifies the way Word adjusts the table when the left indent is changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RulerStyle { + isciiAssamese = "IsciiAssamese", /** - * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. + * ISCII Oriya encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + isciiOriya = "IsciiOriya", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. + * ISCII Kannada encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + isciiKannada = "IsciiKannada", /** - * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * ISCII Malayalam encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + isciiMalayalam = "IsciiMalayalam", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * ISCII Gujarati encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sameWidth = "SameWidth", - } - /** - * Represents the East Asian language to use when breaking lines of text in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLanguageId { + isciiGujarati = "IsciiGujarati", /** - * Represents Traditional Chinese language. + * ISCII Punjabi encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + isciiPunjabi = "IsciiPunjabi", /** - * Represents Japanese language. + * Arabic ASMO encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + arabicAsmo = "ArabicAsmo", /** - * Represents Korean language. + * Arabic Transparent ASMO encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + arabicTransparentAsmo = "ArabicTransparentAsmo", /** - * Represents Simplified Chinese language. + * Korean Johab encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", - } - /** - * Represents the level of line breaking to use for East Asian languages in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLevel { + koreanJohab = "KoreanJohab", /** - * Represents the normal line break level. + * Taiwan CNS encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + taiwanCns = "TaiwanCns", /** - * Represents the strict line break level. + * Taiwan TCA encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - strict = "Strict", + taiwanTca = "TaiwanTca", /** - * Represents the custom line break level. + * Taiwan Eten encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies the character spacing adjustment for a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum JustificationMode { + taiwanEten = "TaiwanEten", /** - * Expands the character spacing + * Taiwan IBM5550 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expand = "Expand", + taiwanIbm5550 = "TaiwanIbm5550", /** - * Compresses the character spacing. + * Taiwan TeleText encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compress = "Compress", + taiwanTeleText = "TaiwanTeleText", /** - * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * Taiwan Wang encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compressKana = "CompressKana", - } - /** - * Specifies the type of template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TemplateType { + taiwanWang = "TaiwanWang", /** - * Represents the normal template type. + * IA5 IRV encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + ia5Irv = "Ia5Irv", /** - * Represents the global template type. + * IA5 German encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - global = "Global", + ia5German = "Ia5German", /** - * Represents the attached template type. + * IA5 Swedish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attached = "Attached", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LanguageId { + ia5Swedish = "Ia5Swedish", /** - * Afrikaans language. + * IA5 Norwegian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - afrikaans = "Afrikaans", + ia5Norwegian = "Ia5Norwegian", /** - * Albanian language. + * US ASCII encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - albanian = "Albanian", + usaAscii = "UsaAscii", /** - * Amharic language. + * T61 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - amharic = "Amharic", + t61 = "T61", /** - * Arabic language. + * ISO 6937 Non-Spacing Accent encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + iso6937NonSpacingAccent = "Iso6937NonSpacingAccent", /** - * Arabic Algerian language. + * KOI8-R encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicAlgeria = "ArabicAlgeria", + koi8R = "Koi8R", /** - * Arabic Bahraini language. + * Ext Alpha Lowercase encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicBahrain = "ArabicBahrain", + extAlphaLowercase = "ExtAlphaLowercase", /** - * Arabic Egyptian language. + * KOI8-U encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicEgypt = "ArabicEgypt", + koi8U = "Koi8U", /** - * Arabic Iraqi language. + * Europa3 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicIraq = "ArabicIraq", + europa3 = "Europa3", /** - * Arabic Jordanian language. + * HZ GB Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicJordan = "ArabicJordan", + hzGbSimplifiedChinese = "HzGbSimplifiedChinese", /** - * Arabic Kuwaiti language. + * Simplified Chinese GB18030 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicKuwait = "ArabicKuwait", + simplifiedChineseGb18030 = "SimplifiedChineseGb18030", /** - * Arabic Lebanese language. + * UTF-7 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLebanon = "ArabicLebanon", + utf7 = "Utf7", /** - * Arabic Libyan language. + * UTF-8 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLibya = "ArabicLibya", + utf8 = "Utf8", + } + /** + * Specifies the compatibility mode that Word uses when opening the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CompatibilityMode { /** - * Arabic Moroccan language. + * Word 2003 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicMorocco = "ArabicMorocco", + word2003 = "Word2003", /** - * Arabic Omani language. + * Word 2007 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicOman = "ArabicOman", + word2007 = "Word2007", /** - * Arabic Qatari language. + * Word 2010 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicQatar = "ArabicQatar", + word2010 = "Word2010", /** - * Arabic Syrian language. + * Word 2013 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicSyria = "ArabicSyria", + word2013 = "Word2013", /** - * Arabic Tunisian language. + * Current Word version compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicTunisia = "ArabicTunisia", + current = "Current", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** - * Arabic United Arab Emirates language. + * Represents that the style is a character style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - arabicUAE = "ArabicUAE", + character = "Character", /** - * Arabic Yemeni language. + * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - arabicYemen = "ArabicYemen", + list = "List", /** - * Armenian language. + * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - armenian = "Armenian", + paragraph = "Paragraph", /** - * Assamese language. + * Represents that the style is a table style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - assamese = "Assamese", + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { /** - * Azerbaijani Cyrillic language. + * Represents outline level 1. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - azeriCyrillic = "AzeriCyrillic", + outlineLevel1 = "OutlineLevel1", /** - * Azerbaijani Latin language. + * Represents outline level 2. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - azeriLatin = "AzeriLatin", + outlineLevel2 = "OutlineLevel2", /** - * Basque (Basque). + * Represents outline level 3. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - basque = "Basque", + outlineLevel3 = "OutlineLevel3", /** - * Belgian Dutch language. + * Represents outline level 4. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belgianDutch = "BelgianDutch", + outlineLevel4 = "OutlineLevel4", /** - * Belgian French language. + * Represents outline level 5. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belgianFrench = "BelgianFrench", + outlineLevel5 = "OutlineLevel5", /** - * Bengali language. + * Represents outline level 6. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - bengali = "Bengali", + outlineLevel6 = "OutlineLevel6", /** - * Bulgarian language. + * Represents outline level 7. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - bulgarian = "Bulgarian", + outlineLevel7 = "OutlineLevel7", /** - * Burmese language. + * Represents outline level 8. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - burmese = "Burmese", + outlineLevel8 = "OutlineLevel8", /** - * Belarusian language. + * Represents outline level 9. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belarusian = "Belarusian", + outlineLevel9 = "OutlineLevel9", /** - * Catalan language. + * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - catalan = "Catalan", + outlineLevelBodyText = "OutlineLevelBodyText", + } + /** + * Specifies the close behavior for `Document.close`. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum CloseBehavior { /** - * Cherokee language. + * Saves the changes before closing the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - cherokee = "Cherokee", + save = "Save", /** - * Chinese Hong Kong SAR language. + * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - chineseHongKongSAR = "ChineseHongKongSAR", + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { /** - * Chinese Macao SAR language. + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - chineseMacaoSAR = "ChineseMacaoSAR", + save = "Save", /** - * Chinese Singapore language. + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - chineseSingapore = "ChineseSingapore", + prompt = "Prompt", + } + /** + * Represents the type of Field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { /** - * Croatian language. + * Represents that the field type is Add-in. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - croatian = "Croatian", + addin = "Addin", /** - * Czech language. + * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - czech = "Czech", + addressBlock = "AddressBlock", /** - * Danish language. + * Represents that the field type is Advance. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - danish = "Danish", + advance = "Advance", /** - * Divehi language. + * Represents that the field type is Ask. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - divehi = "Divehi", + ask = "Ask", /** - * Dutch language. + * Represents that the field type is Author. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - dutch = "Dutch", + author = "Author", /** - * Edo language. + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - edo = "Edo", + autoText = "AutoText", /** - * Australian English language. + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishAUS = "EnglishAUS", + autoTextList = "AutoTextList", /** - * Belize English language. + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishBelize = "EnglishBelize", + barCode = "BarCode", /** - * Canadian English language. + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishCanadian = "EnglishCanadian", + bibliography = "Bibliography", /** - * Caribbean English language. + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishCaribbean = "EnglishCaribbean", + bidiOutline = "BidiOutline", /** - * Indonesian English language. + * Represents that the field type is Citation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishIndonesia = "EnglishIndonesia", + citation = "Citation", /** - * Irish English language. + * Represents that the field type is Comments. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishIreland = "EnglishIreland", + comments = "Comments", /** - * Jamaican English language. + * Represents that the field type is Compare. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishJamaica = "EnglishJamaica", + compare = "Compare", /** - * New Zealand English language. + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishNewZealand = "EnglishNewZealand", + createDate = "CreateDate", /** - * Filipino English language. + * Represents that the field type is Data. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishPhilippines = "EnglishPhilippines", + data = "Data", /** - * South African English language. + * Represents that the field type is Database. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishSouthAfrica = "EnglishSouthAfrica", + database = "Database", /** - * Tobago Trinidad English language. + * Represents that the field type is Date. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishTrinidadTobago = "EnglishTrinidadTobago", + date = "Date", /** - * United Kingdom English language. + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishUK = "EnglishUK", + displayBarcode = "DisplayBarcode", /** - * United States English language. + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishUS = "EnglishUS", + docProperty = "DocProperty", /** - * Zimbabwe English language. + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishZimbabwe = "EnglishZimbabwe", + docVariable = "DocVariable", /** - * Estonian language. + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - estonian = "Estonian", + editTime = "EditTime", /** - * Faeroese language. + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - faeroese = "Faeroese", + embedded = "Embedded", /** - * Filipino language. + * Represents that the field type is Equation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - filipino = "Filipino", + eq = "EQ", /** - * Finnish language. + * Represents that the field type is Expression. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - finnish = "Finnish", + expression = "Expression", /** - * French language. + * Represents that the field type is FileName. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - french = "French", + fileName = "FileName", /** - * French Cameroon language. + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCameroon = "FrenchCameroon", + fileSize = "FileSize", /** - * French Canadian language. + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCanadian = "FrenchCanadian", + fillIn = "FillIn", /** - * French (Congo (DRC)) language. + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCongoDRC = "FrenchCongoDRC", + formCheckbox = "FormCheckbox", /** - * French Cote d'Ivoire language. + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCotedIvoire = "FrenchCotedIvoire", + formDropdown = "FormDropdown", /** - * French Haiti language. + * Represents that the field type is FormText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchHaiti = "FrenchHaiti", + formText = "FormText", /** - * French Luxembourg language. + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchLuxembourg = "FrenchLuxembourg", + gotoButton = "GotoButton", /** - * French Mali language. + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMali = "FrenchMali", + greetingLine = "GreetingLine", /** - * French Monaco language. + * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMonaco = "FrenchMonaco", + hyperlink = "Hyperlink", /** - * French Morocco language. + * Represents that the field type is If. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMorocco = "FrenchMorocco", + if = "If", /** - * French Reunion language. + * Represents that the field type is Import. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchReunion = "FrenchReunion", + import = "Import", /** - * French Senegal language. + * Represents that the field type is Include. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchSenegal = "FrenchSenegal", + include = "Include", /** - * French West Indies language. + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchWestIndies = "FrenchWestIndies", + includePicture = "IncludePicture", /** - * Frisian Netherlands language. + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frisianNetherlands = "FrisianNetherlands", + includeText = "IncludeText", /** - * Fulfulde language. + * Represents that the field type is Index. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - fulfulde = "Fulfulde", + index = "Index", /** - * Irish (Irish) language. + * Represents that the field type is Information. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gaelicIreland = "GaelicIreland", + info = "Info", /** - * Scottish Gaelic language. + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gaelicScotland = "GaelicScotland", + keywords = "Keywords", /** - * Galician language. + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - galician = "Galician", + lastSavedBy = "LastSavedBy", /** - * Georgian language. + * Represents that the field type is Link. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - georgian = "Georgian", + link = "Link", /** - * German language. + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - german = "German", + listNum = "ListNum", /** - * German Austrian language. + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanAustria = "GermanAustria", + macroButton = "MacroButton", /** - * German Liechtenstein language. + * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanLiechtenstein = "GermanLiechtenstein", + mergeBarcode = "MergeBarcode", /** - * German Luxembourg language. + * Represents that the field type is MergeField. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanLuxembourg = "GermanLuxembourg", + mergeField = "MergeField", /** - * Greek language. + * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - greek = "Greek", + mergeRec = "MergeRec", /** - * Guarani language. + * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - guarani = "Guarani", + mergeSeq = "MergeSeq", /** - * Gujarati language. + * Represents that the field type is Next. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gujarati = "Gujarati", + next = "Next", /** - * Hausa language. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hausa = "Hausa", + nextIf = "NextIf", /** - * Hawaiian language. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hawaiian = "Hawaiian", + noteRef = "NoteRef", /** - * Hebrew language. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hebrew = "Hebrew", + numChars = "NumChars", /** - * Hindi language. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hindi = "Hindi", + numPages = "NumPages", /** - * Hungarian language. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hungarian = "Hungarian", + numWords = "NumWords", /** - * Ibibio language. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - ibibio = "Ibibio", + ocx = "OCX", /** - * Icelandic language. + * Represents that the field type is Page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - icelandic = "Icelandic", + page = "Page", /** - * Igbo language. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - igbo = "Igbo", + pageRef = "PageRef", /** - * Indonesian language. + * Represents that the field type is Print. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - indonesian = "Indonesian", + print = "Print", /** - * Inuktitut language. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - inuktitut = "Inuktitut", + printDate = "PrintDate", /** - * Italian language. + * Represents that the field type is Private. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - italian = "Italian", + private = "Private", /** - * Japanese language. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - japanese = "Japanese", + quote = "Quote", /** - * Kannada language. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kannada = "Kannada", + rd = "RD", /** - * Kanuri language. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kanuri = "Kanuri", + ref = "Ref", /** - * Kashmiri language. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kashmiri = "Kashmiri", + revNum = "RevNum", /** - * Kazakh language. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kazakh = "Kazakh", + saveDate = "SaveDate", /** - * Khmer language. + * Represents that the field type is Section. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - khmer = "Khmer", + section = "Section", /** - * Kirghiz language. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kirghiz = "Kirghiz", + sectionPages = "SectionPages", /** - * Konkani language. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - konkani = "Konkani", + seq = "Seq", /** - * Korean language. + * Represents that the field type is Set. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - korean = "Korean", + set = "Set", /** - * Kyrgyz language. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kyrgyz = "Kyrgyz", + shape = "Shape", /** - * No specified language. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageNone = "LanguageNone", + skipIf = "SkipIf", /** - * Lao language. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lao = "Lao", + styleRef = "StyleRef", /** - * Latin language. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - latin = "Latin", + subject = "Subject", /** - * Latvian language. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - latvian = "Latvian", + subscriber = "Subscriber", /** - * Lithuanian language. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lithuanian = "Lithuanian", + symbol = "Symbol", /** - * Macedonian language. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - macedonianFYROM = "MacedonianFYROM", + ta = "TA", /** - * Malayalam language. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malayalam = "Malayalam", + tc = "TC", /** - * Malay Brunei Darussalam language. + * Represents that the field type is Template. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + template = "Template", /** - * Malaysian language. + * Represents that the field type is Time. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malaysian = "Malaysian", + time = "Time", /** - * Maltese language. + * Represents that the field type is Title. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - maltese = "Maltese", + title = "Title", /** - * Manipuri language. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - manipuri = "Manipuri", + toa = "TOA", /** - * Marathi language. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - marathi = "Marathi", + toc = "TOC", /** - * Mexican Spanish language. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - mexicanSpanish = "MexicanSpanish", + userAddress = "UserAddress", /** - * Mongolian language. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - mongolian = "Mongolian", + userInitials = "UserInitials", /** - * Nepali language. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nepali = "Nepali", + userName = "UserName", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - noProofing = "NoProofing", + xe = "XE", /** - * Norwegian Bokmol language. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - norwegianBokmol = "NorwegianBokmol", + empty = "Empty", /** - * Norwegian Nynorsk language. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - norwegianNynorsk = "NorwegianNynorsk", + others = "Others", /** - * Odia (Oriya) language. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - oriya = "Oriya", + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * Oromo language. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - oromo = "Oromo", + none = "None", /** - * Pashto language. + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pashto = "Pashto", + hot = "Hot", /** - * Persian language. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - persian = "Persian", + warm = "Warm", /** - * Polish language. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - polish = "Polish", + cold = "Cold", + } + /** + * Represents the character inserted after the list item mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Portuguese language. + * A tab is inserted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - portuguese = "Portuguese", + trailingTab = "TrailingTab", /** - * Portuguese (Brazil) language. + * A space is inserted. Default. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - portugueseBrazil = "PortugueseBrazil", + trailingSpace = "TrailingSpace", /** - * Punjabi language. + * No character is inserted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - punjabi = "Punjabi", + trailingNone = "TrailingNone", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ListBuiltInNumberStyle { /** - * Rhaeto Romanic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - rhaetoRomanic = "RhaetoRomanic", + none = "None", /** - * Romanian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - romanian = "Romanian", + arabic = "Arabic", /** - * Romanian Moldova language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - romanianMoldova = "RomanianMoldova", + upperRoman = "UpperRoman", /** - * Russian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - russian = "Russian", + lowerRoman = "LowerRoman", /** - * Russian Moldova language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - russianMoldova = "RussianMoldova", + upperLetter = "UpperLetter", /** - * Sami Lappish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - samiLappish = "SamiLappish", + lowerLetter = "LowerLetter", /** - * Sanskrit language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sanskrit = "Sanskrit", + ordinal = "Ordinal", /** - * Serbian Cyrillic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - serbianCyrillic = "SerbianCyrillic", + cardinalText = "CardinalText", /** - * Serbian Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - serbianLatin = "SerbianLatin", + ordinalText = "OrdinalText", /** - * Sesotho language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sesotho = "Sesotho", + kanji = "Kanji", /** - * Simplified Chinese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - simplifiedChinese = "SimplifiedChinese", + kanjiDigit = "KanjiDigit", /** - * Sindhi language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sindhi = "Sindhi", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Sindhi (Pakistan) language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sindhiPakistan = "SindhiPakistan", + irohaHalfWidth = "IrohaHalfWidth", /** - * Sinhalese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sinhalese = "Sinhalese", + arabicFullWidth = "ArabicFullWidth", /** - * Slovakian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - slovak = "Slovak", + kanjiTraditional = "KanjiTraditional", /** - * Slovenian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - slovenian = "Slovenian", + kanjiTraditional2 = "KanjiTraditional2", /** - * Somali language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - somali = "Somali", + numberInCircle = "NumberInCircle", /** - * Sorbian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sorbian = "Sorbian", + aiueo = "Aiueo", /** - * Spanish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanish = "Spanish", + iroha = "Iroha", /** - * Spanish Argentina language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishArgentina = "SpanishArgentina", + arabicLZ = "ArabicLZ", /** - * Spanish Bolivian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishBolivia = "SpanishBolivia", + bullet = "Bullet", /** - * Spanish Chilean language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishChile = "SpanishChile", + ganada = "Ganada", /** - * Spanish Colombian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishColombia = "SpanishColombia", + chosung = "Chosung", /** - * Spanish Costa Rican language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishCostaRica = "SpanishCostaRica", + gbnum1 = "GBNum1", /** - * Spanish Dominican Republic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + gbnum2 = "GBNum2", /** - * Spanish Ecuadorian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishEcuador = "SpanishEcuador", + gbnum3 = "GBNum3", /** - * Spanish El Salvadorian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishElSalvador = "SpanishElSalvador", + gbnum4 = "GBNum4", /** - * Spanish Guatemala language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishGuatemala = "SpanishGuatemala", + zodiac1 = "Zodiac1", /** - * Spanish Honduran language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishHonduras = "SpanishHonduras", + zodiac2 = "Zodiac2", /** - * Spanish Modern Sort language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishModernSort = "SpanishModernSort", + zodiac3 = "Zodiac3", /** - * Spanish Nicaraguan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishNicaragua = "SpanishNicaragua", + tradChinNum1 = "TradChinNum1", /** - * Spanish Panamanian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishPanama = "SpanishPanama", + tradChinNum2 = "TradChinNum2", /** - * Spanish Paraguayan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishParaguay = "SpanishParaguay", + tradChinNum3 = "TradChinNum3", /** - * Spanish Peruvian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishPeru = "SpanishPeru", + tradChinNum4 = "TradChinNum4", /** - * Spanish Puerto Rican language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishPuertoRico = "SpanishPuertoRico", + simpChinNum1 = "SimpChinNum1", /** - * Spanish Uruguayan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishUruguay = "SpanishUruguay", + simpChinNum2 = "SimpChinNum2", /** - * Spanish Venezuelan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishVenezuela = "SpanishVenezuela", + simpChinNum3 = "SimpChinNum3", /** - * Sutu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sutu = "Sutu", + simpChinNum4 = "SimpChinNum4", /** - * Swahili language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swahili = "Swahili", + hanjaRead = "HanjaRead", /** - * Swedish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swedish = "Swedish", + hanjaReadDigit = "HanjaReadDigit", /** - * Swedish Finnish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swedishFinland = "SwedishFinland", + hangul = "Hangul", /** - * Swiss French language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissFrench = "SwissFrench", + hanja = "Hanja", /** - * Swiss German language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissGerman = "SwissGerman", + hebrew1 = "Hebrew1", /** - * Swiss Italian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissItalian = "SwissItalian", + arabic1 = "Arabic1", /** - * Syriac language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - syriac = "Syriac", + hebrew2 = "Hebrew2", /** - * Tajik language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tajik = "Tajik", + arabic2 = "Arabic2", /** - * Tamazight language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamazight = "Tamazight", + hindiLetter1 = "HindiLetter1", /** - * Tamazight Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamazightLatin = "TamazightLatin", + hindiLetter2 = "HindiLetter2", /** - * Tamil language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamil = "Tamil", + hindiArabic = "HindiArabic", /** - * Tatar language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tatar = "Tatar", + hindiCardinalText = "HindiCardinalText", /** - * Telugu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - telugu = "Telugu", + thaiLetter = "ThaiLetter", /** - * Thai language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - thai = "Thai", + thaiArabic = "ThaiArabic", /** - * Tibetan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tibetan = "Tibetan", + thaiCardinalText = "ThaiCardinalText", /** - * Tigrigna Eritrea language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tigrignaEritrea = "TigrignaEritrea", + vietCardinalText = "VietCardinalText", /** - * Tigrigna Ethiopic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tigrignaEthiopic = "TigrignaEthiopic", + lowercaseRussian = "LowercaseRussian", /** - * Traditional Chinese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - traditionalChinese = "TraditionalChinese", + uppercaseRussian = "UppercaseRussian", /** - * Tsonga language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tsonga = "Tsonga", + lowercaseGreek = "LowercaseGreek", /** - * Tswana language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tswana = "Tswana", + uppercaseGreek = "UppercaseGreek", /** - * Turkish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - turkish = "Turkish", + arabicLZ2 = "ArabicLZ2", /** - * Turkmen language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - turkmen = "Turkmen", + arabicLZ3 = "ArabicLZ3", /** - * Ukrainian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ukrainian = "Ukrainian", + arabicLZ4 = "ArabicLZ4", /** - * Urdu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - urdu = "Urdu", + lowercaseTurkish = "LowercaseTurkish", /** - * Uzbek Cyrillic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - uzbekCyrillic = "UzbekCyrillic", + uppercaseTurkish = "UppercaseTurkish", /** - * Uzbek Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - uzbekLatin = "UzbekLatin", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Venda language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - venda = "Venda", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Vietnamese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - vietnamese = "Vietnamese", + pictureBullet = "PictureBullet", /** - * Welsh language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - welsh = "Welsh", + legal = "Legal", /** - * Xhosa language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - xhosa = "Xhosa", + legalLZ = "LegalLZ", + } + /** + * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ShadingTextureType { /** - * Yi language. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yi = "Yi", + darkDiagonalDown = "DarkDiagonalDown", /** - * Yiddish language. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yiddish = "Yiddish", + darkDiagonalUp = "DarkDiagonalUp", /** - * Yoruba language. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yoruba = "Yoruba", + darkGrid = "DarkGrid", /** - * Zulu language. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - zulu = "Zulu", - } - /** - * Specifies how a building block is inserted into a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DocPartInsertType { + darkHorizontal = "DarkHorizontal", /** - * Inserts the content of the building block. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - content = "Content", + darkTrellis = "DarkTrellis", /** - * Inserts the building block as a paragraph. + * Represents dark vertical texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - paragraph = "Paragraph", + darkVertical = "DarkVertical", /** - * Inserts the building block as a page. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - page = "Page", - } - /** - * Specifies the type of building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BuildingBlockType { + lightDiagonalDown = "LightDiagonalDown", /** - * Represents Quick Parts building block type. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - quickParts = "QuickParts", + lightDiagonalUp = "LightDiagonalUp", /** - * Represents Cover Page building block type. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - coverPage = "CoverPage", + lightGrid = "LightGrid", /** - * Represents Equations building block type. + * Represents light horizontal texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - equations = "Equations", + lightHorizontal = "LightHorizontal", /** - * Represents Footers building block type. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - footers = "Footers", + lightTrellis = "LightTrellis", /** - * Represents Headers building block type. + * Represents light vertical texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - headers = "Headers", + lightVertical = "LightVertical", /** - * Represents Page Number building block type. + * Represents that there's no texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumber = "PageNumber", + none = "None", /** - * Represents Tables building block type. + * Represents 10 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tables = "Tables", + percent10 = "Percent10", /** - * Represents Watermarks building block type. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - watermarks = "Watermarks", + percent12Pt5 = "Percent12Pt5", /** - * Represents AutoText building block type. + * Represents 15 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - autoText = "AutoText", + percent15 = "Percent15", /** - * Represents Text Box building block type. + * Represents 20 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - textBox = "TextBox", + percent20 = "Percent20", /** - * Represents Page Number Top building block type. + * Represents 25 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberTop = "PageNumberTop", + percent25 = "Percent25", /** - * Represents Page Number Bottom building block type. + * Represents 30 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberBottom = "PageNumberBottom", + percent30 = "Percent30", /** - * Represents Page Number Page building block type. + * Represents 35 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberPage = "PageNumberPage", + percent35 = "Percent35", /** - * Represents Table of Contents building block type. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tableOfContents = "TableOfContents", + percent37Pt5 = "Percent37Pt5", /** - * Represents Custom Quick Parts building block type. + * Represents 40 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customQuickParts = "CustomQuickParts", + percent40 = "Percent40", /** - * Represents Custom Cover Page building block type. + * Represents 45 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customCoverPage = "CustomCoverPage", + percent45 = "Percent45", /** - * Represents Custom Equations building block type. + * Represents 5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customEquations = "CustomEquations", + percent5 = "Percent5", /** - * Represents Custom Footers building block type. + * Represents 50 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customFooters = "CustomFooters", + percent50 = "Percent50", /** - * Represents Custom Headers building block type. + * Represents 55 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customHeaders = "CustomHeaders", + percent55 = "Percent55", /** - * Represents Custom Page Number building block type. + * Represents 60 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumber = "CustomPageNumber", + percent60 = "Percent60", /** - * Represents Custom Tables building block type. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTables = "CustomTables", + percent62Pt5 = "Percent62Pt5", /** - * Represents Custom Watermarks building block type. + * Represents 65 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - customWatermarks = "CustomWatermarks", - /** - * Represents Custom AutoText building block type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - customAutoText = "CustomAutoText", - /** - * Represents Custom Text Box building block type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTextBox = "CustomTextBox", + percent65 = "Percent65", /** - * Represents Custom Page Number Top building block type. + * Represents 70 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberTop = "CustomPageNumberTop", + percent70 = "Percent70", /** - * Represents Custom Page Number Bottom building block type. + * Represents 75 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberBottom = "CustomPageNumberBottom", + percent75 = "Percent75", /** - * Represents Custom Page Number Page building block type. + * Represents 80 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberPage = "CustomPageNumberPage", + percent80 = "Percent80", /** - * Represents Custom Table of Contents building block type. + * Represents 85 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTableOfContents = "CustomTableOfContents", + percent85 = "Percent85", /** - * Represents Custom building block type 1. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom1 = "Custom1", + percent87Pt5 = "Percent87Pt5", /** - * Represents Custom building block type 2. + * Represents 90 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom2 = "Custom2", + percent90 = "Percent90", /** - * Represents Custom building block type 3. + * Represents 95 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom3 = "Custom3", + percent95 = "Percent95", /** - * Represents Custom building block type 4. + * Represents solid texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom4 = "Custom4", + solid = "Solid", + } + /** + * Specifies the target document for displaying document comparison differences. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum CompareTarget { /** - * Represents Custom building block type 5. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom5 = "Custom5", + compareTargetCurrent = "CompareTargetCurrent", /** - * Represents Bibliography building block type. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bibliography = "Bibliography", + compareTargetSelected = "CompareTargetSelected", /** - * Represents Custom Bibliography building block type. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customBibliography = "CustomBibliography", + compareTargetNew = "CompareTargetNew", } /** - * Represents the type of a {@link Word.CustomXmlValidationError}. + * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - enum CustomXmlValidationErrorType { + enum ImportedStylesConflictBehavior { /** - * Represents a validation error generated by the schema. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - schemaGenerated = "schemaGenerated", + ignore = "Ignore", /** - * Represents a validation error that is automatically cleared. + * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - automaticallyCleared = "automaticallyCleared", + overwrite = "Overwrite", /** - * Represents a validation error that is manually created. + * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - manual = "manual", + createNew = "CreateNew", } /** - * Represents the type of a {@link Word.CustomXmlNode}. + * Represents the shape type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum CustomXmlNodeType { - /** - * Represents an XML element node. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - element = "element", + enum ShapeType { /** - * Represents an XML attribute node. + * Unsupported shape type. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - attribute = "attribute", + unsupported = "Unsupported", /** - * Represents an XML text node. + * Text box shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text = "text", + textBox = "TextBox", /** - * Represents an XML CDATA section node. + * Geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cData = "cData", + geometricShape = "GeometricShape", /** - * Represents an XML processing instruction node. + * Group shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - processingInstruction = "processingInstruction", + group = "Group", /** - * Represents an XML comment node. + * Picture shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - comment = "comment", + picture = "Picture", /** - * Represents an XML document node. + * Canvas shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - document = "document", + canvas = "Canvas", } /** - * Specifies the type of link. + * 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 + * [Api set: WordApiDesktop 1.2] */ - enum LinkType { - /** - * OLE object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - ole = "Ole", + enum RelativeHorizontalPosition { /** - * Picture. + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - picture = "Picture", + margin = "Margin", /** - * Text. + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text = "Text", + page = "Page", /** - * Reference library. + * Relative to column. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - reference = "Reference", + column = "Column", /** - * Include file. + * Relative to character. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - include = "Include", + character = "Character", /** - * Import file. + * Relative to left margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - import = "Import", + leftMargin = "LeftMargin", /** - * Dynamic Data Exchange. + * Relative to right margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dde = "Dde", + rightMargin = "RightMargin", /** - * Automatic DDE. + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ddeAuto = "DdeAuto", + insideMargin = "InsideMargin", /** - * Microsoft Excel chart. + * Relative to outside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chart = "Chart", + outsideMargin = "OutsideMargin", } /** - * Specifies the action associated with the verb that the OLE object should perform. + * 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 + * [Api set: WordApiDesktop 1.2] */ - enum OleVerb { + enum RelativeVerticalPosition { /** - * Performs the verb that is invoked when the user double-clicks the object. + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - primary = "Primary", + margin = "Margin", /** - * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - show = "Show", + page = "Page", /** - * Opens the object in a separate window. + * Relative to paragraph. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - open = "Open", + paragraph = "Paragraph", /** - * Removes the object's user interface from view. + * Relative to line. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hide = "Hide", + line = "Line", /** - * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * Relative to top margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - uiActivate = "UiActivate", + topMargin = "TopMargin", /** - * Runs the object and installs its window, but doesn't install any user-interface tools. + * Relative to bottom margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - inPlaceActivate = "InPlaceActivate", + bottomMargin = "BottomMargin", /** - * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - discardUndoState = "DiscardUndoState", + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", } /** - * Represents the list formatting characteristics of a range. + * Represents what the horizontal or vertical size 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 + * [Api set: WordApiDesktop 1.2] */ - export class ListFormat 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; + enum RelativeSize { /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly list: Word.List; + margin = "Margin", /** - * Gets the list template associated with the `ListFormat` object. - * + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listTemplate: Word.ListTemplate; + page = "Page", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Relative to top margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly isSingleList: boolean; + topMargin = "TopMargin", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * Relative to bottom margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly isSingleListTemplate: boolean; + bottomMargin = "BottomMargin", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listLevelNumber: number; + insideMargin = "InsideMargin", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * Relative to outside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listString: string; + outsideMargin = "OutsideMargin", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum GeometricShapeType { /** - * Gets the type of the list for the `ListFormat` object. - * + * Line inverse geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + lineInverse = "LineInverse", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * Triangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listValue: number; + triangle = "Triangle", /** - * 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. + * Right triangle geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListFormat): void; + rightTriangle = "RightTriangle", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * [Api set: WordApiDesktop 1.2] */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + rectangle = "Rectangle", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Diamond geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * [Api set: WordApiDesktop 1.2] */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + diamond = "Diamond", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * Parallelogram geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param listTemplate - The list template to apply. - * @param options - Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. + * [Api set: WordApiDesktop 1.2] */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + parallelogram = "Parallelogram", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Trapezoid geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + trapezoid = "Trapezoid", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Non-isosceles trapezoid geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Pentagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + pentagon = "Pentagon", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Hexagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + hexagon = "Hexagon", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * Heptagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param listTemplate - The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. + * [Api set: WordApiDesktop 1.2] */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + heptagon = "Heptagon", /** - * Converts numbers in the list to plain text. - * + * Octagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType - Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.2] */ - convertNumbersToText(numberType: Word.NumberType): void; + octagon = "Octagon", /** - * Converts numbers in the list to plain text. - * + * Decagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType - Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.2] */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + decagon = "Decagon", /** - * Counts the numbered items in the list. - * + * Dodecagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - Optional. Options for counting numbered items, such as the type of number and the level to count. - * @returns The number of items. + * [Api set: WordApiDesktop 1.2] */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + dodecagon = "Dodecagon", /** - * Indents the list by one level. - * + * Star 4-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listIndent(): void; + star4 = "Star4", /** - * Outdents the list by one level. - * + * Star 5-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listOutdent(): void; + star5 = "Star5", /** - * Removes numbering from the list. - * + * Star 6-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType - Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.2] */ - removeNumbers(numberType: Word.NumberType): void; + star6 = "Star6", /** - * Removes numbering from the list. - * + * Star 7-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType - Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.2] */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + star7 = "Star7", /** - * 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. + * Star 8-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + star8 = "Star8", /** - * 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. + * Star 10-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ListFormat; + star10 = "Star10", /** - * 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. + * Star 12-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListFormat; + star12 = "Star12", /** - * 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. + * Star 16-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ListFormat; + star16 = "Star16", /** - * 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. + * Star 24-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ListFormat; + star24 = "Star24", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Star 32-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ListFormatCountNumberedItemsOptions { + star32 = "Star32", /** - * If provided, specifies the level to count. The default value is 1. - * + * Round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - level?: number; + roundRectangle = "RoundRectangle", /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. - * + * Round one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; - } - /** - * Represents options for applying a list template to a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ListTemplateApplyOptions { + round1Rectangle = "Round1Rectangle", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - applyLevel?: number; + round2SameRectangle = "Round2SameRectangle", /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. - * + * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - continuePreviousList?: boolean; + snipRoundRectangle = "SnipRoundRectangle", /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. - * + * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; - } - /** - * Represents the fill formatting for a shape or text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class FillFormat 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; + snip1Rectangle = "Snip1Rectangle", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly backgroundColor: Word.ColorFormat; + snip2SameRectangle = "Snip2SameRectangle", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * Plaque geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gradientAngle: number; + plaque = "Plaque", /** - * Gets the gradient color type. - * + * Ellipse geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + ellipse = "Ellipse", /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. - * + * Teardrop geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientDegree: number; + teardrop = "Teardrop", /** - * Returns the gradient style for the fill. - * + * Home plate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + homePlate = "HomePlate", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * Chevron geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientVariant: number; + chevron = "Chevron", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Pie wedge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + pieWedge = "PieWedge", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * Pie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + pie = "Pie", /** - * Returns the preset gradient type for the fill. - * + * Block arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + blockArc = "BlockArc", /** - * Gets the preset texture. - * + * Donut geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + donut = "Donut", /** - * Specifies whether the fill rotates with the shape. - * + * No smoking geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotateWithObject: boolean; + noSmoking = "NoSmoking", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * Right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + rightArrow = "RightArrow", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * Left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureHorizontalScale: number; + leftArrow = "LeftArrow", /** - * Returns the name of the custom texture file for the fill. - * + * Up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly textureName: string; + upArrow = "UpArrow", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * Down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureOffsetX: number; + downArrow = "DownArrow", /** - * Specifies the vertical offset of the texture. - * + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureOffsetY: number; + stripedRightArrow = "StripedRightArrow", /** - * Specifies whether the texture is tiled. - * + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureTile: boolean; + notchedRightArrow = "NotchedRightArrow", /** - * Returns the texture type for the fill. - * + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + bentUpArrow = "BentUpArrow", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureVerticalScale: number; + leftRightArrow = "LeftRightArrow", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + upDownArrow = "UpDownArrow", /** - * Gets the fill format type. - * + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + leftUpArrow = "LeftUpArrow", /** - * 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. + * Left-right-up arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.FillFormat): void; + leftRightUpArrow = "LeftRightUpArrow", /** - * Sets the fill to a one-color gradient. - * + * Quad arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param style - The gradient style. - * @param variant - The gradient variant. Can be a value from 1 to 4. - * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.2] */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + quadArrow = "QuadArrow", /** - * Sets the fill to a one-color gradient. - * + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param style - The gradient style. - * @param variant - The gradient variant. Can be a value from 1 to 4. - * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.2] */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + leftArrowCallout = "LeftArrowCallout", /** - * Sets the fill to a pattern. - * + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPatterned(pattern: Word.PatternType): void; + rightArrowCallout = "RightArrowCallout", /** - * Sets the fill to a pattern. - * + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + upArrowCallout = "UpArrowCallout", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + downArrowCallout = "DownArrowCallout", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Sets the fill to a preset texture. - * + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + upDownArrowCallout = "UpDownArrowCallout", /** - * Sets the fill to a preset texture. - * + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + quadArrowCallout = "QuadArrowCallout", /** - * Sets the fill to a two-color gradient. - * + * Bent arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + bentArrow = "BentArrow", /** - * Sets the fill to a two-color gradient. - * + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + uturnArrow = "UturnArrow", /** - * Sets the fill to a uniform color. - * + * Circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - solid(): void; + circularArrow = "CircularArrow", /** - * 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. + * Left circular arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; + leftCircularArrow = "LeftCircularArrow", /** - * 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. + * Left-right circular arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.FillFormat; + leftRightCircularArrow = "LeftRightCircularArrow", /** - * 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. + * Curved right arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.FillFormat; + curvedRightArrow = "CurvedRightArrow", /** - * 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. + * Curved left arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.FillFormat; + curvedLeftArrow = "CurvedLeftArrow", /** - * 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. + * Curved up arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.FillFormat; + curvedUpArrow = "CurvedUpArrow", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FillFormatData; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class GlowFormat 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; - /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly color: Word.ColorFormat; + curvedDownArrow = "CurvedDownArrow", /** - * Specifies the length of the radius for a glow effect. - * + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - radius: number; + swooshArrow = "SwooshArrow", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Cube geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + cube = "Cube", /** - * 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. + * Can geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GlowFormat): void; + can = "Can", /** - * 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. + * Lightning bolt geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + lightningBolt = "LightningBolt", /** - * 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. + * Heart geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.GlowFormat; + heart = "Heart", /** - * 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. + * Sun geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + sun = "Sun", /** - * 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. + * Moon geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.GlowFormat; + moon = "Moon", /** - * 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. + * Smiley face geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.GlowFormat; + smileyFace = "SmileyFace", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Irregular seal 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.GlowFormatData; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class LineFormat 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; + irregularSeal1 = "IrregularSeal1", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly backgroundColor: Word.ColorFormat; + irregularSeal2 = "IrregularSeal2", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * Folded corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + foldedCorner = "FoldedCorner", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * Bevel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + bevel = "Bevel", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * Frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + frame = "Frame", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * Half frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + halfFrame = "HalfFrame", /** - * Specifies the dash style for the line. - * + * Corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + corner = "Corner", /** - * Specifies the length of the arrowhead at the end of the line. - * + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + diagonalStripe = "DiagonalStripe", /** - * Specifies the style of the arrowhead at the end of the line. - * + * Chord geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + chord = "Chord", /** - * Specifies the width of the arrowhead at the end of the line. - * + * Arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + arc = "Arc", /** - * Specifies if to draw lines inside a shape. - * + * Left bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insetPen: boolean; + leftBracket = "LeftBracket", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Right bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + rightBracket = "RightBracket", /** - * Specifies the pattern applied to the line. - * + * Left brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + leftBrace = "LeftBrace", /** - * Specifies the line format style. - * + * Right brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + rightBrace = "RightBrace", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Bracket pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + bracketPair = "BracketPair", /** - * Specifies the thickness of the line in points. - * + * Brace pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weight: number; + bracePair = "BracePair", /** - * 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. + * Callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineFormat): void; + callout1 = "Callout1", /** - * 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. + * Callout 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + callout2 = "Callout2", /** - * 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. + * Callout 3 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.LineFormat; + callout3 = "Callout3", /** - * 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. + * Accent callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + accentCallout1 = "AccentCallout1", /** - * 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. + * Accent callout 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.LineFormat; + accentCallout2 = "AccentCallout2", /** - * 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. + * Accent callout 3 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.LineFormat; + accentCallout3 = "AccentCallout3", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Border callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.LineFormatData; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ReflectionFormat 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; + borderCallout1 = "BorderCallout1", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - blur: number; + borderCallout2 = "BorderCallout2", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offset: number; + borderCallout3 = "BorderCallout3", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - size: number; + accentBorderCallout1 = "AccentBorderCallout1", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + accentBorderCallout2 = "AccentBorderCallout2", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + accentBorderCallout3 = "AccentBorderCallout3", /** - * 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. + * Wedge rectangle callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ReflectionFormat): void; + wedgeRectCallout = "WedgeRectCallout", /** - * 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. + * Wedge rounded rectangle callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + wedgeRRectCallout = "WedgeRRectCallout", /** - * 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. + * Wedge ellipse callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * 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. + * Cloud callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ReflectionFormat; + cloudCallout = "CloudCallout", /** - * 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. + * Cloud geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ReflectionFormat; + cloud = "Cloud", /** - * 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. + * Ribbon geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ReflectionFormat; + ribbon = "Ribbon", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Ribbon 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ReflectionFormatData; - } - /** - * Represents the color formatting of a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ColorFormat 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; + ribbon2 = "Ribbon2", /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - brightness: number; + ellipseRibbon = "EllipseRibbon", /** - * Specifies the theme color for a color format. - * + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + ellipseRibbon2 = "EllipseRibbon2", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rgb: string; + leftRightRibbon = "LeftRightRibbon", /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tintAndShade: number; + verticalScroll = "VerticalScroll", /** - * Returns the shape color type. - * + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly type: Word.ColorType | "rgb" | "scheme"; + horizontalScroll = "HorizontalScroll", /** - * 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. + * Wave geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ColorFormat): void; + wave = "Wave", /** - * 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. + * Double wave geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + doubleWave = "DoubleWave", /** - * 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. + * Plus geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ColorFormat; + plus = "Plus", /** - * 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. + * Flow chart process geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ColorFormat; + flowChartProcess = "FlowChartProcess", /** - * 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. + * Flow chart decision geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ColorFormat; + flowChartDecision = "FlowChartDecision", /** - * 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. + * Flow chart input-output geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ColorFormat; + flowChartInputOutput = "FlowChartInputOutput", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Flow chart predefined process geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ColorFormatData; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ShadowFormat 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; + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Flow chart document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - blur: number; + flowChartDocument = "FlowChartDocument", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + flowChartMultidocument = "FlowChartMultidocument", /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. - * + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - obscured: boolean; + flowChartTerminator = "FlowChartTerminator", /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offsetX: number; + flowChartPreparation = "FlowChartPreparation", /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. - * + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offsetY: number; + flowChartManualInput = "FlowChartManualInput", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotateWithShape: boolean; + flowChartManualOperation = "FlowChartManualOperation", /** - * Specifies the width of the shadow. - * + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - size: number; + flowChartConnector = "FlowChartConnector", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Specifies the shape shadow type. - * + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + flowChartSummingJunction = "FlowChartSummingJunction", /** - * 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. + * Flow chart OR geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadowFormat): void; + flowChartOr = "FlowChartOr", /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementOffsetX(increment: number): void; + flowChartCollate = "FlowChartCollate", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Flow chart sort geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementOffsetY(increment: number): void; + flowChartSort = "FlowChartSort", /** - * 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. + * Flow chart extract geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; + flowChartExtract = "FlowChartExtract", /** - * 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. + * Flow chart merge geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ShadowFormat; + flowChartMerge = "FlowChartMerge", /** - * 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. + * Flow chart offline storage geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadowFormat; + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * 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. + * Flow chart online storage geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ShadowFormat; + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * 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. + * Flow chart magnetic tape geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ShadowFormat; + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Flow chart magnetic disk geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ShadowFormatData; - } - /** - * Represents a shape's three-dimensional formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ThreeDimensionalFormat 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; + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly contourColor: Word.ColorFormat; + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Flow chart display geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly extrusionColor: Word.ColorFormat; + flowChartDisplay = "FlowChartDisplay", /** - * Specifies the depth of the bottom bevel. - * + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomDepth: number; + flowChartDelay = "FlowChartDelay", /** - * Specifies the inset size for the bottom bevel. - * + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomInset: number; + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Specifies the depth of the top bevel. - * + * Action button blank geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopDepth: number; + actionButtonBlank = "ActionButtonBlank", /** - * Specifies the inset size for the top bevel. - * + * Action button home geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopInset: number; + actionButtonHome = "ActionButtonHome", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Action button help geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + actionButtonHelp = "ActionButtonHelp", /** - * Specifies the width of the contour of a shape. - * + * Action button information geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - contourWidth: number; + actionButtonInformation = "ActionButtonInformation", /** - * Specifies the depth of the shape's extrusion. - * + * Action button forward next geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - depth: number; + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * + * Action button back previous geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Specifies the amount of perspective for a shape. - * + * Action button end geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fieldOfView: number; + actionButtonEnd = "ActionButtonEnd", /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * + * Action button beginning geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isPerspective: boolean; + actionButtonBeginning = "ActionButtonBeginning", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Action button return geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + actionButtonReturn = "ActionButtonReturn", /** - * Specifies the angle of the lighting. - * + * Action button document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightAngle: number; + actionButtonDocument = "ActionButtonDocument", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Action button sound geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + actionButtonSound = "ActionButtonSound", /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * Action button movie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + actionButtonMovie = "ActionButtonMovie", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Gear 6 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + gear6 = "Gear6", /** - * Specifies the position of the light source relative to the extrusion. - * + * Gear 9 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + gear9 = "Gear9", /** - * Specifies the intensity of the extrusion lighting. - * + * Funnel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + funnel = "Funnel", /** - * Specifies the extrusion surface material. - * + * Math plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + mathPlus = "MathPlus", /** - * Returns the preset extrusion format. - * + * Math minus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + mathMinus = "MathMinus", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Math multiply geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - projectText: boolean; + mathMultiply = "MathMultiply", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Math divide geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationX: number; + mathDivide = "MathDivide", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Math equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationY: number; + mathEqual = "MathEqual", /** - * Specifies the z-axis rotation of the camera. - * + * Math not equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationZ: number; + mathNotEqual = "MathNotEqual", /** - * Specifies the position on the z-axis for the shape. - * + * Corner tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - z: number; + cornerTabs = "CornerTabs", /** - * 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. + * Square tabs geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ThreeDimensionalFormat): void; + squareTabs = "SquareTabs", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationHorizontal(increment: number): void; + plaqueTabs = "PlaqueTabs", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Chart X geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationVertical(increment: number): void; + chartX = "ChartX", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Chart star geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationX(increment: number): void; + chartStar = "ChartStar", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Chart plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationY(increment: number): void; + chartPlus = "ChartPlus", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. - * + * No fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationZ(increment: number): void; + noFill = "NoFill", /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. - * + * Solid fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - resetRotation(): void; + solid = "Solid", /** - * Sets the direction of the extrusion's sweep path. - * + * Gradient fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param presetExtrusionDirection - The preset direction. + * [Api set: WordApiDesktop 1.2] */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + gradient = "Gradient", /** - * Sets the direction of the extrusion's sweep path. - * + * Pattern fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param presetExtrusionDirection - The preset direction. + * [Api set: WordApiDesktop 1.2] */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + pattern = "Pattern", /** - * Sets the camera preset for the shape. - The preset camera type. - * + * Picture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + picture = "Picture", /** - * Sets the camera preset for the shape. - The preset camera type. - * + * Texture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + texture = "Texture", /** - * Sets the preset extrusion format. - The preset format. - * + * Mixed fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + mixed = "Mixed", + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextVerticalAlignment { /** - * Sets the preset extrusion format. - The preset format. - * + * Anchor the text at the top of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + top = "Top", /** - * 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. + * Anchor the text at the middle of the bounding rectangle. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + middle = "Middle", /** - * 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. + * Anchor the text at the bottom of the bounding rectangle. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + bottom = "Bottom", + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextOrientation { /** - * 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. + * No orientation, such as in a new geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ThreeDimensionalFormat; + none = "None", /** - * 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. + * Horizontal text. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ThreeDimensionalFormat; + horizontal = "Horizontal", /** - * 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. + * A special version of vertical text, where some fonts are displayed as if rotated. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ThreeDimensionalFormat; + eastAsianVertical = "EastAsianVertical", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ThreeDimensionalFormatData; + vertical270 = "Vertical270", + /** + * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + vertical = "Vertical", + /** + * A special version of vertical text, where some fonts are displayed as if rotated. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + /** + * A combination of automatic orientation is used. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + mixed = "Mixed", } /** - * Specifies the length of the arrowhead at the end of a line. + * Determines the type of automatic sizing allowed. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum ArrowheadLength { + enum ShapeAutoSize { /** - * Represents a mixed arrowhead length. + * No autosizing. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + none = "None", /** - * Represents a short arrowhead length. + * The text is adjusted to fit the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - short = "Short", + textToFitShape = "TextToFitShape", /** - * Represents a medium arrowhead length. + * The shape is adjusted to fit the text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - medium = "Medium", + shapeToFitText = "ShapeToFitText", /** - * Represents a long arrowhead length. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - long = "Long", + mixed = "Mixed", } /** - * Specifies the style of the arrowhead at the end of a line. + * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum ArrowheadStyle { + enum ShapeTextWrapType { /** - * Represents a mixed arrowhead style. + * Places the shape in line with text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + inline = "Inline", /** - * Represents no arrowhead. + * Wraps text squarely around the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + */ + square = "Square", + /** + * Wraps text close to the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + tight = "Tight", + /** + * Wraps text around and through the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + through = "Through", + /** + * Places text above and below the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topBottom = "TopBottom", + /** + * Places shape behind text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + behind = "Behind", + /** + * Places shape in front of text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + front = "Front", + } + /** + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapSide { + /** + * Has no wrap side property, such as those for inline shapes. + * @remarks + * [Api set: WordApiDesktop 1.2] */ none = "None", /** - * Represents a triangle arrowhead style. + * Both left and right sides of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangle = "Triangle", + both = "Both", /** - * Represents an open arrowhead style. + * Left side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - open = "Open", + left = "Left", /** - * Represents a stealth arrowhead style. + * Right side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stealth = "Stealth", + right = "Right", /** - * Represents a diamond arrowhead style. + * Side of the shape that's farther from the respective page margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - diamond = "Diamond", + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { /** - * Represents an oval arrowhead style. + * Scale from current size of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - oval = "Oval", + currentSize = "CurrentSize", + /** + * Scale from original size of the shape. It only works for pictures. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + originalSize = "OriginalSize", } /** - * Specifies the width of the arrowhead at the end of a line. + * Specifies which part of the shape retains its position when the shape is scaled. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum ArrowheadWidth { + enum ShapeScaleFrom { /** - * Represents a mixed arrowhead width. + * Scale from the top left corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + scaleFromTopLeft = "ScaleFromTopLeft", /** - * Represents a narrow arrowhead width. + * Scale from the center of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromMiddle = "ScaleFromMiddle", + /** + * Scale from the bottom right corner of the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + scaleFromBottomRight = "ScaleFromBottomRight", + } + /** + * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FrameSizeRule { + /** + * The height or width is set according to the height or width of the item in the frame. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + auto = "Auto", /** - * Represents a medium arrowhead width. + * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + atLeast = "AtLeast", /** - * Represents a wide arrowhead width. + * The height or width is set to an exact value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", + exact = "Exact", } /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * Specifies the border style for an object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BevelType { + enum BorderLineStyle { /** - * Represents a mixed bevel type. + * No line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + none = "None", /** - * Represents no bevel. + * Single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + single = "Single", /** - * Represents a relaxed inset bevel. + * Dotted line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relaxedInset = "relaxedInset", + dot = "Dot", /** - * Represents a circle bevel. + * Dashed line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circle = "circle", + dashSmallGap = "DashSmallGap", /** - * Represents a slope bevel. + * Dashed line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slope = "slope", + dashLargeGap = "DashLargeGap", /** - * Represents a cross bevel. + * Dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "cross", + dashDot = "DashDot", /** - * Represents an angle bevel. + * Dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angle = "angle", + dashDotDot = "DashDotDot", /** - * Represents a soft round bevel. + * Double line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softRound = "softRound", + double = "Double", /** - * Represents a convex bevel. + * Triple line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - convex = "convex", + triple = "Triple", /** - * Represents a cool slant bevel. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coolSlant = "coolSlant", + thinThickSmallGap = "ThinThickSmallGap", /** - * Represents a divot bevel. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "divot", + thickThinSmallGap = "ThickThinSmallGap", /** - * Represents a riblet bevel. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - riblet = "riblet", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Represents a hard edge bevel. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hardEdge = "hardEdge", + thinThickMedGap = "ThinThickMedGap", /** - * Represents an art deco bevel. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artDeco = "artDeco", - } - /** - * Represents color index values in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorIndex { + thickThinMedGap = "ThickThinMedGap", /** - * Automatically determines the color. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Represents the color black. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - black = "Black", + thinThickLargeGap = "ThinThickLargeGap", /** - * Represents the color blue. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blue = "Blue", + thickThinLargeGap = "ThickThinLargeGap", /** - * Represents the color turquoise. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turquoise = "Turquoise", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Represents a bright green color. + * Single wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightGreen = "BrightGreen", + singleWavy = "SingleWavy", /** - * Represents the color pink. + * Double wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pink = "Pink", + doubleWavy = "DoubleWavy", /** - * Represents the color red. + * Dash-dot stroked line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - red = "Red", + dashDotStroked = "DashDotStroked", /** - * Represents the color yellow. + * Embossed 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yellow = "Yellow", + emboss3D = "Emboss3D", /** - * Represents the color white. + * Engraved 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - white = "White", + engrave3D = "Engrave3D", /** - * Represents a dark blue color. + * Outset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkBlue = "DarkBlue", + outset = "Outset", /** - * Represents the color teal. + * Inset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - teal = "Teal", + inset = "Inset", + } + /** + * Specifies the width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineWidth { /** - * Represents the color green. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - green = "Green", + pt025 = "Pt025", /** - * Represents the color violet. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - violet = "Violet", + pt050 = "Pt050", /** - * Represents a dark red color. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkRed = "DarkRed", + pt075 = "Pt075", /** - * Represents a dark yellow color. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkYellow = "DarkYellow", + pt100 = "Pt100", /** - * Represents a gray color with 50% intensity. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray50 = "Gray50", + pt150 = "Pt150", /** - * Represents a gray color with 25% intensity. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray25 = "Gray25", + pt225 = "Pt225", /** - * Represents a classic red color. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicRed = "ClassicRed", + pt300 = "Pt300", /** - * Represents a classic blue color. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicBlue = "ClassicBlue", + pt450 = "Pt450", /** - * Represents a color determined by the author. + * Represents a line width of 6.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - byAuthor = "ByAuthor", + pt600 = "Pt600", } /** - * Specifies the color type. + * Specifies the graphical page border setting of a page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ColorType { + enum PageBorderArt { /** - * Represents an RGB color type. + * Represents a border with apple design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb = "rgb", + apples = "Apples", /** - * Represents a scheme color type. + * Represents a border with maple muffin design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scheme = "scheme", - } - /** - * Specifies whether the formatting from the previous list can be continued. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Continue { + mapleMuffins = "MapleMuffins", /** - * Formatting cannot continue from the previous list. + * Represents a border with cake slice design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disabled = "Disabled", + cakeSlice = "CakeSlice", /** - * Formatting can continue from the previous list. + * Represents a border with candy corn design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + candyCorn = "CandyCorn", /** - * Numbering can be restarted. + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reset = "Reset", - } - /** - * Specifies the default list behavior for a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DefaultListBehavior { + iceCreamCones = "IceCreamCones", /** - * Use formatting compatible with Microsoft Word 97. + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word97 = "Word97", + champagneBottle = "ChampagneBottle", /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. + * Represents a border with party glass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word2000 = "Word2000", + partyGlass = "PartyGlass", /** - * Use formatting compatible with Microsoft Word 2002. + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word2002 = "Word2002", - } - /** - * Specifies the type of emphasis mark to use for a character or designated character string. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum EmphasisMark { + christmasTree = "ChristmasTree", /** - * No emphasis mark. + * Represents a border with trees design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + trees = "Trees", /** - * Emphasis mark over a solid circle. + * Represents a border with palm trees in color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overSolidCircle = "OverSolidCircle", + palmsColor = "PalmsColor", /** - * Emphasis mark over a comma. + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overComma = "OverComma", + balloons3Colors = "Balloons3Colors", /** - * Emphasis mark over a white circle. + * Represents a border with hot air balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overWhiteCircle = "OverWhiteCircle", + balloonsHotAir = "BalloonsHotAir", /** - * Emphasis mark under a solid circle. + * Represents a border with party favor design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underSolidCircle = "UnderSolidCircle", - } - /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ExtrusionColorType { + partyFavor = "PartyFavor", /** - * Represents a mixed extrusion color type. + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + confettiStreamers = "ConfettiStreamers", /** - * Represents an automatic extrusion color based on the shape's fill. + * Represents a border with hearts design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "automatic", + hearts = "Hearts", /** - * Represents a custom extrusion color independent of the shape's fill. + * Represents a border with heart balloon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "custom", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FillType { + heartBalloon = "HeartBalloon", /** - * Represents a mixed fill type. + * Represents a border with 3D stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + stars3D = "Stars3D", /** - * Represents a solid fill type. + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + starsShadowed = "StarsShadowed", /** - * Represents a patterned fill type. + * Represents a border with stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - patterned = "Patterned", + stars = "Stars", /** - * Represents a gradient fill type. + * Represents a border with sun design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + sun = "Sun", /** - * Represents a textured fill type. + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textured = "Textured", + earth2 = "Earth2", /** - * Represents a background fill type. + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background = "Background", + earth1 = "Earth1", /** - * Represents a picture fill type. + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", - } - /** - * Specifies the type of gradient used in a shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientColorType { + peopleHats = "PeopleHats", /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * Represents a border with sombrero design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + sombrero = "Sombrero", /** - * Gradient with a single color and varying transparency or brightness. + * Represents a border with pencils design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oneColor = "OneColor", + pencils = "Pencils", /** - * Gradient that blends two distinct colors. + * Represents a border with packages design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoColors = "TwoColors", + packages = "Packages", /** - * Gradient that uses a predefined set of colors. + * Represents a border with clocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetColors = "PresetColors", + clocks = "Clocks", /** - * Gradient that includes more than two colors, often customized. + * Represents a border with firecrackers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiColor = "MultiColor", - } - /** - * Specifies the style for a gradient fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientStyle { + firecrackers = "Firecrackers", /** - * Represents a mixed gradient style. + * Represents a border with rings design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + rings = "Rings", /** - * Represents a horizontal gradient style. + * Represents a border with map pins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + mapPins = "MapPins", /** - * Represents a vertical gradient style. + * Represents a border with confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + confetti = "Confetti", /** - * Represents a diagonal-up gradient style. + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalUp = "DiagonalUp", + creaturesButterfly = "CreaturesButterfly", /** - * Represents a diagonal-down gradient style. + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalDown = "DiagonalDown", + creaturesLadyBug = "CreaturesLadyBug", /** - * Represents a gradient style from the corner. + * Represents a border with fish creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromCorner = "FromCorner", + creaturesFish = "CreaturesFish", /** - * Represents a gradient style from the title. + * Represents a border with birds in flight design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromTitle = "FromTitle", + birdsFlight = "BirdsFlight", /** - * Represents a gradient style from the center. + * Represents a border with scared cat design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromCenter = "FromCenter", - } - /** - * Specifies the type of ligature applied to a font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Ligature { + scaredCat = "ScaredCat", /** - * No ligatures applied. + * Represents a border with bats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + bats = "Bats", /** - * Standard ligatures applied. + * Represents a border with roses flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + flowersRoses = "FlowersRoses", /** - * Contextual ligatures applied. + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextual = "Contextual", + flowersRedRose = "FlowersRedRose", /** - * Standard and contextual ligatures applied. + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextual = "StandardContextual", + poinsettias = "Poinsettias", /** - * Historical ligatures applied. + * Represents a border with holly design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historical = "Historical", + holly = "Holly", /** - * Standard and historical ligatures applied. + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistorical = "StandardHistorical", + flowersTiny = "FlowersTiny", /** - * Contextual and historical ligatures applied. + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistorical = "ContextualHistorical", + flowersPansy = "FlowersPansy", /** - * Standard, contextual, and historical ligatures applied. + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualHistorical = "StandardContextualHistorical", + flowersModern2 = "FlowersModern2", /** - * Discretional ligatures applied. + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - discretional = "Discretional", + flowersModern1 = "FlowersModern1", /** - * Standard and discretional ligatures applied. + * Represents a border with white flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardDiscretional = "StandardDiscretional", + whiteFlowers = "WhiteFlowers", /** - * Contextual and discretional ligatures applied. + * Represents a border with vine design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualDiscretional = "ContextualDiscretional", + vine = "Vine", /** - * Standard, contextual, and discretional ligatures applied. + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualDiscretional = "StandardContextualDiscretional", + flowersDaisies = "FlowersDaisies", /** - * Historical and discretional ligatures applied. + * Represents a border with block print flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historicalDiscretional = "HistoricalDiscretional", + flowersBlockPrint = "FlowersBlockPrint", /** - * Standard, historical, and discretional ligatures applied. + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + decoArchColor = "DecoArchColor", /** - * Contextual, historical, and discretional ligatures applied. + * Represents a border with fans design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + fans = "Fans", /** - * All ligatures applied. + * Represents a border with film design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", - } - /** - * Indicates the effects lighting for an object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LightRigType { + film = "Film", /** - * Represents a mixed light rig type. + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + lightning1 = "Lightning1", /** - * Represents legacy flat light rig type 1. + * Represents a border with compass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat1 = "LegacyFlat1", + compass = "Compass", /** - * Represents legacy flat light rig type 2. + * Represents a border with double D design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat2 = "LegacyFlat2", + doubleD = "DoubleD", /** - * Represents legacy flat light rig type 3. + * Represents a border with classical wave design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat3 = "LegacyFlat3", + classicalWave = "ClassicalWave", /** - * Represents legacy flat light rig type 4. + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat4 = "LegacyFlat4", + shadowedSquares = "ShadowedSquares", /** - * Represents legacy normal light rig type 1. + * Represents a border with twisted lines design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal1 = "LegacyNormal1", + twistedLines1 = "TwistedLines1", /** - * Represents legacy normal light rig type 2. + * Represents a border with waveline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal2 = "LegacyNormal2", + waveline = "Waveline", /** - * Represents legacy normal light rig type 3. + * Represents a border with quadrants design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal3 = "LegacyNormal3", + quadrants = "Quadrants", /** - * Represents legacy normal light rig type 4. + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal4 = "LegacyNormal4", + checkedBarColor = "CheckedBarColor", /** - * Represents legacy harsh light rig type 1. + * Represents a border with swirligig design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh1 = "LegacyHarsh1", + swirligig = "Swirligig", /** - * Represents legacy harsh light rig type 2. + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh2 = "LegacyHarsh2", + pushPinNote1 = "PushPinNote1", /** - * Represents legacy harsh light rig type 3. + * Represents a border with push pin note design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh3 = "LegacyHarsh3", + pushPinNote2 = "PushPinNote2", /** - * Represents legacy harsh light rig type 4. + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh4 = "LegacyHarsh4", + pumpkin1 = "Pumpkin1", /** - * Represents a three-point light rig type. + * Represents a border with black eggs design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threePoint = "ThreePoint", + eggsBlack = "EggsBlack", /** - * Represents a balanced light rig type. + * Represents a border with cup design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balanced = "Balanced", + cup = "Cup", /** - * Represents a soft light rig type. + * Represents a border with gray heart design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - soft = "Soft", + heartGray = "HeartGray", /** - * Represents a harsh light rig type. + * Represents a border with gingerbread man design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - harsh = "Harsh", + gingerbreadMan = "GingerbreadMan", /** - * Represents a flood light rig type. + * Represents a border with baby pacifier design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flood = "Flood", + babyPacifier = "BabyPacifier", /** - * Represents a contrasting light rig type. + * Represents a border with baby rattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contrasting = "Contrasting", + babyRattle = "BabyRattle", /** - * Represents a morning light rig type. + * Represents a border with cabins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - morning = "Morning", + cabins = "Cabins", /** - * Represents a sunrise light rig type. + * Represents a border with funky house design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunrise = "Sunrise", + houseFunky = "HouseFunky", /** - * Represents a sunset light rig type. + * Represents a border with black stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunset = "Sunset", + starsBlack = "StarsBlack", /** - * Represents a chilly light rig type. + * Represents a border with snowflakes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chilly = "Chilly", + snowflakes = "Snowflakes", /** - * Represents a freezing light rig type. + * Represents a border with fancy snowflake design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - freezing = "Freezing", + snowflakeFancy = "SnowflakeFancy", /** - * Represents a flat light rig type. + * Represents a border with skyrocket design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + skyrocket = "Skyrocket", /** - * Represents a two-point light rig type. + * Represents a border with Seattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPoint = "TwoPoint", + seattle = "Seattle", /** - * Represents a glow light rig type. + * Represents a border with music notes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow = "Glow", + musicNotes = "MusicNotes", /** - * Represents a bright room light rig type. + * Represents a border with black palms design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightRoom = "BrightRoom", - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineDashStyle { + palmsBlack = "PalmsBlack", /** - * Represents a mixed dash style. + * Represents a border with maple leaf design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + mapleLeaf = "MapleLeaf", /** - * Represents a solid line style. + * Represents a border with paper clips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + paperClips = "PaperClips", /** - * Represents a square dot line style. + * Represents a border with shorebird tracks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareDot = "SquareDot", + shorebirdTracks = "ShorebirdTracks", /** - * Represents a round dot line style. + * Represents a border with people design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - roundDot = "RoundDot", + people = "People", /** - * Represents a dashed line style. + * Represents a border with people waving design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + peopleWaving = "PeopleWaving", /** - * Represents a dash-dot line style. + * Represents a border with eclipsing squares design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + eclipsingSquares2 = "EclipsingSquares2", /** - * Represents a dash-dot-dot line style. + * Represents a border with hypnotic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + hypnotic = "Hypnotic", /** - * Represents a long dash line style. + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDash = "LongDash", + diamondsGray = "DiamondsGray", /** - * Represents a long dash-dot line style. + * Represents a border with deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDot = "LongDashDot", + decoArch = "DecoArch", /** - * Represents a long dash-dot-dot line style. + * Represents a border with deco blocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDotDot = "LongDashDotDot", + decoBlocks = "DecoBlocks", /** - * Represents a system dash line style. + * Represents a border with circles and lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDash = "SysDash", + circlesLines = "CirclesLines", /** - * Represents a system dot line style. + * Represents a border with papyrus design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDot = "SysDot", + papyrus = "Papyrus", /** - * Represents a system dash-dot line style. + * Represents a border with woodwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDashDot = "SysDashDot", - } - /** - * Specifies the style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineFormatStyle { + woodwork = "Woodwork", /** - * Represents a mixed line style. + * Represents a border with weaving braid design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + weavingBraid = "WeavingBraid", /** - * Represents a single line style. + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + weavingRibbon = "WeavingRibbon", /** - * Represents a thin-thin line style. + * Represents a border with weaving angles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThin = "ThinThin", + weavingAngles = "WeavingAngles", /** - * Represents a thin-thick line style. + * Represents a border with arched scallops design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThick = "ThinThick", + archedScallops = "ArchedScallops", /** - * Represents a thick-thin line style. + * Represents a border with safari design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThin = "ThickThin", + safari = "Safari", /** - * Represents a thick line between two thin lines style. + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickBetweenThin = "ThickBetweenThin", - } - /** - * Specifies the portion of a list to which to apply a list template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListApplyTo { + celticKnotwork = "CelticKnotwork", /** - * Applies the list template to the entire list. + * Represents a border with crazy maze design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wholeList = "WholeList", + crazyMaze = "CrazyMaze", /** - * Applies the list template from the cursor insertion point to the end of the list. + * Represents a border with eclipsing squares design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thisPointForward = "ThisPointForward", + eclipsingSquares1 = "EclipsingSquares1", /** - * Applies the list template to the selection. + * Represents a border with birds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListType { + birds = "Birds", /** - * List with no bullets, numbering, or outlining. + * Represents a border with teacup and flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNoNumbering = "ListNoNumbering", + flowersTeacup = "FlowersTeacup", /** - * ListNum fields that can be used in the body of a paragraph. + * Represents a border with northwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listListNumOnly = "ListListNumOnly", + northwest = "Northwest", /** - * Bulleted list. + * Represents a border with southwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listBullet = "ListBullet", + southwest = "Southwest", /** - * Simple numeric list. + * Represents a border with tribal design (variant 6). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listSimpleNumbering = "ListSimpleNumbering", + tribal6 = "Tribal6", /** - * Outlined list. + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutlineNumbering = "ListOutlineNumbering", + tribal4 = "Tribal4", /** - * Mixed numeric list. + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listMixedNumbering = "ListMixedNumbering", + tribal3 = "Tribal3", /** - * Picture bulleted list. + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listPictureBullet = "ListPictureBullet", - } - /** - * Specifies the number form setting for an OpenType font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberForm { + tribal2 = "Tribal2", /** - * Default number form setting. + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + tribal5 = "Tribal5", /** - * Lining number form setting. + * Represents a border with X illusions design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lining = "Lining", + xillusions = "XIllusions", /** - * Old-style number form setting. + * Represents a border with zany triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oldStyle = "OldStyle", - } - /** - * Specifies the number spacing setting for an OpenType font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberSpacing { + zanyTriangles = "ZanyTriangles", /** - * Default number spacing setting. + * Represents a border with pyramids design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + pyramids = "Pyramids", /** - * Proportional number spacing setting. + * Represents a border with pyramids above design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + pyramidsAbove = "PyramidsAbove", /** - * Tabular number spacing setting. + * Represents a border with gray confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabular = "Tabular", - } - /** - * Specifies the type of numbers in a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberType { + confettiGrays = "ConfettiGrays", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Represents a border with outline confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + confettiOutline = "ConfettiOutline", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Represents a border with white confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNum = "ListNum", + confettiWhite = "ConfettiWhite", /** - * Default value for all other cases. + * Represents a border with mosaic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allNumbers = "AllNumbers", - } - /** - * Specifies the fill pattern used in a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PatternType { + mosaic = "Mosaic", /** - * Represents a mixed pattern type. + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + lightning2 = "Lightning2", /** - * Represents a 5 percent fill pattern. + * Represents a border with heebie jeebies design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent5 = "Percent5", + heebieJeebies = "HeebieJeebies", /** - * Represents a 10 percent fill pattern. + * Represents a border with light bulb design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent10 = "Percent10", + lightBulb = "LightBulb", /** - * Represents a 20 percent fill pattern. + * Represents a border with gradient design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent20 = "Percent20", + gradient = "Gradient", /** - * Represents a 25 percent fill pattern. + * Represents a border with triangle party design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent25 = "Percent25", + triangleParty = "TriangleParty", /** - * Represents a 30 percent fill pattern. + * Represents a border with twisted lines design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent30 = "Percent30", + twistedLines2 = "TwistedLines2", /** - * Represents a 40 percent fill pattern. + * Represents a border with moons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent40 = "Percent40", + moons = "Moons", /** - * Represents a 50 percent fill pattern. + * Represents a border with ovals design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent50 = "Percent50", + ovals = "Ovals", /** - * Represents a 60 percent fill pattern. + * Represents a border with double diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent60 = "Percent60", + doubleDiamonds = "DoubleDiamonds", /** - * Represents a 70 percent fill pattern. + * Represents a border with chain link design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent70 = "Percent70", + chainLink = "ChainLink", /** - * Represents a 75 percent fill pattern. + * Represents a border with triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent75 = "Percent75", + triangles = "Triangles", /** - * Represents an 80 percent fill pattern. + * Represents a border with tribal design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent80 = "Percent80", + tribal1 = "Tribal1", /** - * Represents a 90 percent fill pattern. + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent90 = "Percent90", + marqueeToothed = "MarqueeToothed", /** - * Represents a dark horizontal fill pattern. + * Represents a border with sharks teeth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkHorizontal = "DarkHorizontal", + sharksTeeth = "SharksTeeth", /** - * Represents a dark vertical fill pattern. + * Represents a border with sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkVertical = "DarkVertical", + sawtooth = "Sawtooth", /** - * Represents a dark downward diagonal fill pattern. + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + sawtoothGray = "SawtoothGray", /** - * Represents a dark upward diagonal fill pattern. + * Represents a border with postage stamp design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + postageStamp = "PostageStamp", /** - * Represents a small checkerboard fill pattern. + * Represents a border with weaving strips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCheckerBoard = "SmallCheckerBoard", + weavingStrips = "WeavingStrips", /** - * Represents a trellis fill pattern. + * Represents a border with zigzag design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trellis = "Trellis", + zigZag = "ZigZag", /** - * Represents a light horizontal fill pattern. + * Represents a border with cross stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightHorizontal = "LightHorizontal", + crossStitch = "CrossStitch", /** - * Represents a light vertical fill pattern. + * Represents a border with gems design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightVertical = "LightVertical", + gems = "Gems", /** - * Represents a light downward diagonal fill pattern. + * Represents a border with circles and rectangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightDownwardDiagonal = "LightDownwardDiagonal", + circlesRectangles = "CirclesRectangles", /** - * Represents a light upward diagonal fill pattern. + * Represents a border with corner triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightUpwardDiagonal = "LightUpwardDiagonal", + cornerTriangles = "CornerTriangles", /** - * Represents a small grid fill pattern. + * Represents a border with insects creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallGrid = "SmallGrid", + creaturesInsects = "CreaturesInsects", /** - * Represents a dotted diamond fill pattern. + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedDiamond = "DottedDiamond", + zigZagStitch = "ZigZagStitch", /** - * Represents a wide downward diagonal fill pattern. + * Represents a border with checkered design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideDownwardDiagonal = "WideDownwardDiagonal", + checkered = "Checkered", /** - * Represents a wide upward diagonal fill pattern. + * Represents a border with black checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideUpwardDiagonal = "WideUpwardDiagonal", + checkedBarBlack = "CheckedBarBlack", /** - * Represents a dashed upward diagonal fill pattern. + * Represents a border with marquee design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + marquee = "Marquee", /** - * Represents a dashed downward diagonal fill pattern. + * Represents a border with basic white dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + basicWhiteDots = "BasicWhiteDots", /** - * Represents a narrow vertical fill pattern. + * Represents a border with basic wide midline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowVertical = "NarrowVertical", + basicWideMidline = "BasicWideMidline", /** - * Represents a narrow horizontal fill pattern. + * Represents a border with basic wide outline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowHorizontal = "NarrowHorizontal", + basicWideOutline = "BasicWideOutline", /** - * Represents a dashed vertical fill pattern. + * Represents a border with basic wide inline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedVertical = "DashedVertical", + basicWideInline = "BasicWideInline", /** - * Represents a dashed horizontal fill pattern. + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedHorizontal = "DashedHorizontal", + basicThinLines = "BasicThinLines", /** - * Represents a large confetti fill pattern. + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeConfetti = "LargeConfetti", + basicWhiteDashes = "BasicWhiteDashes", /** - * Represents a large grid fill pattern. + * Represents a border with basic white squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeGrid = "LargeGrid", + basicWhiteSquares = "BasicWhiteSquares", /** - * Represents a horizontal brick fill pattern. + * Represents a border with basic black squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalBrick = "HorizontalBrick", + basicBlackSquares = "BasicBlackSquares", /** - * Represents a large checkerboard fill pattern. + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeCheckerBoard = "LargeCheckerBoard", + basicBlackDashes = "BasicBlackDashes", /** - * Represents a small confetti fill pattern. + * Represents a border with basic black dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallConfetti = "SmallConfetti", + basicBlackDots = "BasicBlackDots", /** - * Represents a zigzag fill pattern. + * Represents a border with top stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + starsTop = "StarsTop", /** - * Represents a solid diamond fill pattern. + * Represents a border with certificate banner design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solidDiamond = "SolidDiamond", + certificateBanner = "CertificateBanner", /** - * Represents a diagonal brick fill pattern. + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalBrick = "DiagonalBrick", + handmade1 = "Handmade1", /** - * Represents an outlined diamond fill pattern. + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinedDiamond = "OutlinedDiamond", + handmade2 = "Handmade2", /** - * Represents a plaid fill pattern. + * Represents a border with torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plaid = "Plaid", + tornPaper = "TornPaper", /** - * Represents a sphere fill pattern. + * Represents a border with black torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sphere = "Sphere", + tornPaperBlack = "TornPaperBlack", /** - * Represents a weave fill pattern. + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weave = "Weave", + couponCutoutDashes = "CouponCutoutDashes", /** - * Represents a dotted grid fill pattern. + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedGrid = "DottedGrid", + couponCutoutDots = "CouponCutoutDots", + } + /** + * Specifies the preferred unit of measure to use when measuring the width of an item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PreferredWidthType { /** - * Represents a divot fill pattern. + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "Divot", + auto = "Auto", /** - * Represents a shingle fill pattern. + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shingle = "Shingle", + percent = "Percent", /** - * Represents a wave fill pattern. + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wave = "Wave", + points = "Points", + } + /** + * Represents the reading order of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingOrder { /** - * Represents a horizontal fill pattern. + * Represents right-to-left reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + rightToLeft = "RightToLeft", /** - * Represents a vertical fill pattern. + * Represents left-to-right reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + leftToRight = "LeftToRight", + } + /** + * Specifies the way Word adjusts the table when the left indent is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RulerStyle { /** - * Represents a cross fill pattern. + * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "Cross", + none = "None", /** - * Represents a downward diagonal fill pattern. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downwardDiagonal = "DownwardDiagonal", + proportional = "Proportional", /** - * Represents an upward diagonal fill pattern. + * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upwardDiagonal = "UpwardDiagonal", + firstColumn = "FirstColumn", /** - * Represents a diagonal cross fill pattern. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalCross = "DiagonalCross", + sameWidth = "SameWidth", } /** - * Indicates the effects camera type used by the specified object. + * Represents the East Asian language to use when breaking lines of text in the specified document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetCamera { + enum FarEastLineBreakLanguageId { /** - * Represents a mixed camera type. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + traditionalChinese = "TraditionalChinese", /** - * Represents a legacy oblique top-left camera type. + * Represents Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + japanese = "Japanese", /** - * Represents a legacy oblique top camera type. + * Represents Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTop = "LegacyObliqueTop", + korean = "Korean", /** - * Represents a legacy oblique top-right camera type. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + simplifiedChinese = "SimplifiedChinese", + } + /** + * Represents the level of line breaking to use for East Asian languages in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLevel { /** - * Represents a legacy oblique left camera type. + * Represents the normal line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueLeft = "LegacyObliqueLeft", + normal = "Normal", /** - * Represents a legacy oblique front camera type. + * Represents the strict line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueFront = "LegacyObliqueFront", + strict = "Strict", /** - * Represents a legacy oblique right camera type. + * Represents the custom line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueRight = "LegacyObliqueRight", + custom = "Custom", + } + /** + * Specifies the character spacing adjustment for a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum JustificationMode { /** - * Represents a legacy oblique bottom-left camera type. + * Expands the character spacing * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + expand = "Expand", /** - * Represents a legacy oblique bottom camera type. + * Compresses the character spacing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottom = "LegacyObliqueBottom", + compress = "Compress", /** - * Represents a legacy oblique bottom-right camera type. + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + compressKana = "CompressKana", + } + /** + * Specifies the type of template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TemplateType { /** - * Represents a legacy perspective top-left camera type. + * Represents the normal template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + normal = "Normal", /** - * Represents a legacy perspective top camera type. + * Represents the global template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + global = "Global", /** - * Represents a legacy perspective top-right camera type. + * Represents the attached template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + attached = "Attached", + } + /** + * Represents the language ID of a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LanguageId { /** - * Represents a legacy perspective left camera type. + * Afrikaans language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + afrikaans = "Afrikaans", /** - * Represents a legacy perspective front camera type. + * Albanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + albanian = "Albanian", /** - * Represents a legacy perspective right camera type. + * Amharic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + amharic = "Amharic", /** - * Represents a legacy perspective bottom-left camera type. + * Arabic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + arabic = "Arabic", /** - * Represents a legacy perspective bottom camera type. + * Arabic Algerian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + arabicAlgeria = "ArabicAlgeria", /** - * Represents a legacy perspective bottom-right camera type. + * Arabic Bahraini language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + arabicBahrain = "ArabicBahrain", /** - * Represents an orthographic front camera type. + * Arabic Egyptian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orthographicFront = "OrthographicFront", + arabicEgypt = "ArabicEgypt", /** - * Represents an isometric top-up camera type. + * Arabic Iraqi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopUp = "IsometricTopUp", + arabicIraq = "ArabicIraq", /** - * Represents an isometric top-down camera type. + * Arabic Jordanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopDown = "IsometricTopDown", + arabicJordan = "ArabicJordan", /** - * Represents an isometric bottom-up camera type. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomUp = "IsometricBottomUp", + arabicKuwait = "ArabicKuwait", /** - * Represents an isometric bottom-down camera type. + * Arabic Lebanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomDown = "IsometricBottomDown", + arabicLebanon = "ArabicLebanon", /** - * Represents an isometric left-up camera type. + * Arabic Libyan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftUp = "IsometricLeftUp", + arabicLibya = "ArabicLibya", /** - * Represents an isometric left-down camera type. + * Arabic Moroccan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftDown = "IsometricLeftDown", + arabicMorocco = "ArabicMorocco", /** - * Represents an isometric right-up camera type. + * Arabic Omani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightUp = "IsometricRightUp", + arabicOman = "ArabicOman", /** - * Represents an isometric right-down camera type. + * Arabic Qatari language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightDown = "IsometricRightDown", + arabicQatar = "ArabicQatar", /** - * Represents an isometric off-axis 1 left camera type. + * Arabic Syrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + arabicSyria = "ArabicSyria", /** - * Represents an isometric off-axis 1 right camera type. + * Arabic Tunisian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + arabicTunisia = "ArabicTunisia", /** - * Represents an isometric off-axis 1 top camera type. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + arabicUAE = "ArabicUAE", /** - * Represents an isometric off-axis 2 left camera type. + * Arabic Yemeni language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + arabicYemen = "ArabicYemen", /** - * Represents an isometric off-axis 2 right camera type. + * Armenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + armenian = "Armenian", /** - * Represents an isometric off-axis 2 top camera type. + * Assamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + assamese = "Assamese", /** - * Represents an isometric off-axis 3 left camera type. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Left = "IsometricOffAxis3Left", + azeriCyrillic = "AzeriCyrillic", /** - * Represents an isometric off-axis 3 right camera type. + * Azerbaijani Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + azeriLatin = "AzeriLatin", /** - * Represents an isometric off-axis 3 bottom camera type. + * Basque (Basque). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + basque = "Basque", /** - * Represents an isometric off-axis 4 left camera type. + * Belgian Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + belgianDutch = "BelgianDutch", /** - * Represents an isometric off-axis 4 right camera type. + * Belgian French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + belgianFrench = "BelgianFrench", /** - * Represents an isometric off-axis 4 bottom camera type. + * Bengali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + bengali = "Bengali", /** - * Represents an oblique top-left camera type. + * Bulgarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopLeft = "ObliqueTopLeft", + bulgarian = "Bulgarian", /** - * Represents an oblique top camera type. + * Burmese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTop = "ObliqueTop", + burmese = "Burmese", /** - * Represents an oblique top-right camera type. + * Belarusian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopRight = "ObliqueTopRight", + belarusian = "Belarusian", /** - * Represents an oblique left camera type. + * Catalan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueLeft = "ObliqueLeft", + catalan = "Catalan", /** - * Represents an oblique right camera type. + * Cherokee language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueRight = "ObliqueRight", + cherokee = "Cherokee", /** - * Represents an oblique bottom-left camera type. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomLeft = "ObliqueBottomLeft", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Represents an oblique bottom camera type. + * Chinese Macao SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottom = "ObliqueBottom", + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Represents an oblique bottom-right camera type. + * Chinese Singapore language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomRight = "ObliqueBottomRight", + chineseSingapore = "ChineseSingapore", /** - * Represents a perspective front camera type. + * Croatian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveFront = "PerspectiveFront", + croatian = "Croatian", /** - * Represents a perspective left camera type. + * Czech language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveLeft = "PerspectiveLeft", + czech = "Czech", /** - * Represents a perspective right camera type. + * Danish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRight = "PerspectiveRight", + danish = "Danish", /** - * Represents a perspective above camera type. + * Divehi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAbove = "PerspectiveAbove", + divehi = "Divehi", /** - * Represents a perspective below camera type. + * Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveBelow = "PerspectiveBelow", + dutch = "Dutch", /** - * Represents a perspective above-left facing camera type. + * Edo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + edo = "Edo", /** - * Represents a perspective above-right facing camera type. + * Australian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + englishAUS = "EnglishAUS", /** - * Represents a perspective contrasting-left facing camera type. + * Belize English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + englishBelize = "EnglishBelize", /** - * Represents a perspective contrasting-right facing camera type. + * Canadian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + englishCanadian = "EnglishCanadian", /** - * Represents a perspective heroic-left facing camera type. + * Caribbean English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + englishCaribbean = "EnglishCaribbean", /** - * Represents a perspective heroic-right facing camera type. + * Indonesian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + englishIndonesia = "EnglishIndonesia", /** - * Represents a perspective heroic-extreme left facing camera type. + * Irish English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + englishIreland = "EnglishIreland", /** - * Represents a perspective heroic-extreme right facing camera type. + * Jamaican English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + englishJamaica = "EnglishJamaica", /** - * Represents a relaxed perspective camera type. + * New Zealand English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxed = "PerspectiveRelaxed", + englishNewZealand = "EnglishNewZealand", /** - * Represents a moderately relaxed perspective camera type. + * Filipino English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", - } - /** - * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetExtrusionDirection { + englishPhilippines = "EnglishPhilippines", /** - * Represents a mixed extrusion direction. + * South African English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + englishSouthAfrica = "EnglishSouthAfrica", /** - * Represents an extrusion direction to the bottom-right. + * Tobago Trinidad English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + englishTrinidadTobago = "EnglishTrinidadTobago", /** - * Represents an extrusion direction to the bottom. + * United Kingdom English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + englishUK = "EnglishUK", /** - * Represents an extrusion direction to the bottom-left. + * United States English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + englishUS = "EnglishUS", /** - * Represents an extrusion direction to the right. + * Zimbabwe English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + englishZimbabwe = "EnglishZimbabwe", /** - * Represents no extrusion direction. + * Estonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + estonian = "Estonian", /** - * Represents an extrusion direction to the left. + * Faeroese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + faeroese = "Faeroese", /** - * Represents an extrusion direction to the top-right. + * Filipino language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + filipino = "Filipino", /** - * Represents an extrusion direction to the top. + * Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + finnish = "Finnish", /** - * Represents an extrusion direction to the top-left. + * French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", - } - /** - * Specifies which predefined gradient to use to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetGradientType { + french = "French", /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * French Cameroon language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + frenchCameroon = "FrenchCameroon", /** - * A warm gradient resembling an early sunset. + * French Canadian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earlySunset = "EarlySunset", + frenchCanadian = "FrenchCanadian", /** - * A deeper, richer gradient resembling a late sunset. + * French (Congo (DRC)) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lateSunset = "LateSunset", + frenchCongoDRC = "FrenchCongoDRC", /** - * A dark gradient evoking the colors of nightfall. + * French Cote d'Ivoire language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nightfall = "Nightfall", + frenchCotedIvoire = "FrenchCotedIvoire", /** - * A light gradient representing the colors of daybreak. + * French Haiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - daybreak = "Daybreak", + frenchHaiti = "FrenchHaiti", /** - * A gradient that mimics the colors of the horizon. + * French Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizon = "Horizon", + frenchLuxembourg = "FrenchLuxembourg", /** - * A warm, sandy gradient inspired by desert tones. + * French Mali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - desert = "Desert", + frenchMali = "FrenchMali", /** - * A cool gradient reflecting ocean hues. + * French Monaco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ocean = "Ocean", + frenchMonaco = "FrenchMonaco", /** - * A soft, tranquil gradient resembling calm water. + * French Morocco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calmWater = "CalmWater", + frenchMorocco = "FrenchMorocco", /** - * A vivid gradient with fiery tones. + * French Reunion language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fire = "Fire", + frenchReunion = "FrenchReunion", /** - * A muted gradient with fog-like softness. + * French Senegal language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fog = "Fog", + frenchSenegal = "FrenchSenegal", /** - * A natural green gradient inspired by moss. + * French West Indies language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moss = "Moss", + frenchWestIndies = "FrenchWestIndies", /** - * A vibrant gradient with peacock feather colors. + * Frisian Netherlands language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peacock = "Peacock", + frisianNetherlands = "FrisianNetherlands", /** - * A light, golden gradient resembling wheat. + * Fulfulde language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wheat = "Wheat", + fulfulde = "Fulfulde", /** - * A warm, aged paper-like gradient. + * Irish (Irish) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + gaelicIreland = "GaelicIreland", /** - * A rich, reddish-brown gradient like mahogany wood. + * Scottish Gaelic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mahogany = "Mahogany", + gaelicScotland = "GaelicScotland", /** - * A colorful gradient resembling a rainbow. + * Galician language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbow = "Rainbow", + galician = "Galician", /** - * A variation of the rainbow gradient with different color emphasis. + * Georgian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbowII = "RainbowII", + georgian = "Georgian", /** - * A shiny, metallic gold gradient. + * German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gold = "Gold", + german = "German", /** - * A variation of the gold gradient with different tones. + * German Austrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - goldII = "GoldII", + germanAustria = "GermanAustria", /** - * A metallic gradient resembling brass. + * German Liechtenstein language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brass = "Brass", + germanLiechtenstein = "GermanLiechtenstein", /** - * A sleek, reflective chrome gradient. + * German Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chrome = "Chrome", + germanLuxembourg = "GermanLuxembourg", /** - * A variation of the chrome gradient with alternate highlights. + * Greek language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chromeII = "ChromeII", + greek = "Greek", /** - * A smooth, metallic silver gradient. + * Guarani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - silver = "Silver", + guarani = "Guarani", /** - * A deep blue gradient inspired by sapphire. + * Gujarati language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sapphire = "Sapphire", - } - /** - * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingDirection { + gujarati = "Gujarati", /** - * Represents a mixed lighting direction. + * Hausa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + hausa = "Hausa", /** - * Represents lighting from the top-left. + * Hawaiian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + hawaiian = "Hawaiian", /** - * Represents lighting from the top. + * Hebrew language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + hebrew = "Hebrew", /** - * Represents lighting from the top-right. + * Hindi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + hindi = "Hindi", /** - * Represents lighting from the left. + * Hungarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + hungarian = "Hungarian", /** - * Represents no lighting. + * Ibibio language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + ibibio = "Ibibio", /** - * Represents lighting from the right. + * Icelandic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + icelandic = "Icelandic", /** - * Represents lighting from the bottom-left. + * Igbo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + igbo = "Igbo", /** - * Represents lighting from the bottom. + * Indonesian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + indonesian = "Indonesian", /** - * Represents lighting from the bottom-right. + * Inuktitut language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", - } - /** - * Specifies the intensity of light used on a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingSoftness { + inuktitut = "Inuktitut", /** - * Represents a mixed lighting softness. + * Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + italian = "Italian", /** - * Represents dim lighting. + * Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dim = "Dim", + japanese = "Japanese", /** - * Represents normal lighting. + * Kannada language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + kannada = "Kannada", /** - * Represents bright lighting. + * Kanuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bright = "Bright", - } - /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetMaterial { + kanuri = "Kanuri", /** - * Represents a mixed material type. + * Kashmiri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + kashmiri = "Kashmiri", /** - * Represents a matte material. + * Kazakh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte = "Matte", + kazakh = "Kazakh", /** - * Represents a plastic material. + * Khmer language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic = "Plastic", + khmer = "Khmer", /** - * Represents a metal material. + * Kirghiz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal = "Metal", + kirghiz = "Kirghiz", /** - * Represents a wireframe material. + * Konkani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wireFrame = "WireFrame", + konkani = "Konkani", /** - * Represents a second matte material. + * Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte2 = "Matte2", + korean = "Korean", /** - * Represents a second plastic material. + * Kyrgyz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic2 = "Plastic2", + kyrgyz = "Kyrgyz", /** - * Represents a second metal material. + * No specified language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal2 = "Metal2", + languageNone = "LanguageNone", /** - * Represents a warm matte material. + * Lao language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warmMatte = "WarmMatte", + lao = "Lao", /** - * Represents a translucent powder material. + * Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - translucentPowder = "TranslucentPowder", + latin = "Latin", /** - * Represents a powder material. + * Latvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - powder = "Powder", + latvian = "Latvian", /** - * Represents a dark edge material. + * Lithuanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkEdge = "DarkEdge", + lithuanian = "Lithuanian", /** - * Represents a soft edge material. + * Macedonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softEdge = "SoftEdge", + macedonianFYROM = "MacedonianFYROM", /** - * Represents a clear material. + * Malayalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clear = "Clear", + malayalam = "Malayalam", /** - * Represents a flat material. + * Malay Brunei Darussalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + malayBruneiDarussalam = "MalayBruneiDarussalam", /** - * Represents a soft metal material. + * Malaysian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softMetal = "SoftMetal", - } - /** - * Specifies texture to be used to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetTexture { + malaysian = "Malaysian", /** - * Represents a mixed texture type. + * Maltese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + maltese = "Maltese", /** - * Represents a papyrus texture. + * Manipuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + manipuri = "Manipuri", /** - * Represents a canvas texture. + * Marathi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canvas = "Canvas", + marathi = "Marathi", /** - * Represents a denim texture. + * Mexican Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - denim = "Denim", + mexicanSpanish = "MexicanSpanish", /** - * Represents a woven mat texture. + * Mongolian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wovenMat = "WovenMat", + mongolian = "Mongolian", /** - * Represents a water droplets texture. + * Nepali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waterDroplets = "WaterDroplets", + nepali = "Nepali", /** - * Represents a paper bag texture. + * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperBag = "PaperBag", + noProofing = "NoProofing", /** - * Represents a fish fossil texture. + * Norwegian Bokmol language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fishFossil = "FishFossil", + norwegianBokmol = "NorwegianBokmol", /** - * Represents a sand texture. + * Norwegian Nynorsk language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sand = "Sand", + norwegianNynorsk = "NorwegianNynorsk", /** - * Represents a green marble texture. + * Odia (Oriya) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greenMarble = "GreenMarble", + oriya = "Oriya", /** - * Represents a white marble texture. + * Oromo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteMarble = "WhiteMarble", + oromo = "Oromo", /** - * Represents a brown marble texture. + * Pashto language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brownMarble = "BrownMarble", + pashto = "Pashto", /** - * Represents a granite texture. + * Persian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - granite = "Granite", + persian = "Persian", /** - * Represents a newsprint texture. + * Polish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newsprint = "Newsprint", + polish = "Polish", /** - * Represents a recycled paper texture. + * Portuguese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - recycledPaper = "RecycledPaper", + portuguese = "Portuguese", /** - * Represents a parchment texture. + * Portuguese (Brazil) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + portugueseBrazil = "PortugueseBrazil", /** - * Represents a stationery texture. + * Punjabi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stationery = "Stationery", + punjabi = "Punjabi", /** - * Represents a blue tissue paper texture. + * Rhaeto Romanic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blueTissuePaper = "BlueTissuePaper", + rhaetoRomanic = "RhaetoRomanic", /** - * Represents a pink tissue paper texture. + * Romanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pinkTissuePaper = "PinkTissuePaper", + romanian = "Romanian", /** - * Represents a purple mesh texture. + * Romanian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - purpleMesh = "PurpleMesh", + romanianMoldova = "RomanianMoldova", /** - * Represents a bouquet texture. + * Russian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bouquet = "Bouquet", + russian = "Russian", /** - * Represents a cork texture. + * Russian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cork = "Cork", + russianMoldova = "RussianMoldova", /** - * Represents a walnut texture. + * Sami Lappish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - walnut = "Walnut", + samiLappish = "SamiLappish", /** - * Represents an oak texture. + * Sanskrit language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oak = "Oak", + sanskrit = "Sanskrit", /** - * Represents a medium wood texture. + * Serbian Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mediumWood = "MediumWood", - } - /** - * Specifies an extrusion (three-dimensional) format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetThreeDimensionalFormat { + serbianCyrillic = "SerbianCyrillic", /** - * Represents a mixed three-dimensional format. + * Serbian Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + serbianLatin = "SerbianLatin", /** - * Represents three-dimensional format 1. + * Sesotho language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format1 = "Format1", + sesotho = "Sesotho", /** - * Represents three-dimensional format 2. + * Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format2 = "Format2", + simplifiedChinese = "SimplifiedChinese", /** - * Represents three-dimensional format 3. + * Sindhi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format3 = "Format3", + sindhi = "Sindhi", /** - * Represents three-dimensional format 4. + * Sindhi (Pakistan) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format4 = "Format4", + sindhiPakistan = "SindhiPakistan", /** - * Represents three-dimensional format 5. + * Sinhalese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format5 = "Format5", + sinhalese = "Sinhalese", /** - * Represents three-dimensional format 6. + * Slovakian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format6 = "Format6", + slovak = "Slovak", /** - * Represents three-dimensional format 7. + * Slovenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format7 = "Format7", + slovenian = "Slovenian", /** - * Represents three-dimensional format 8. + * Somali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format8 = "Format8", + somali = "Somali", /** - * Represents three-dimensional format 9. + * Sorbian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format9 = "Format9", + sorbian = "Sorbian", /** - * Represents three-dimensional format 10. + * Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format10 = "Format10", + spanish = "Spanish", /** - * Represents three-dimensional format 11. + * Spanish Argentina language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format11 = "Format11", + spanishArgentina = "SpanishArgentina", /** - * Represents three-dimensional format 12. + * Spanish Bolivian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format12 = "Format12", + spanishBolivia = "SpanishBolivia", /** - * Represents three-dimensional format 13. + * Spanish Chilean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format13 = "Format13", + spanishChile = "SpanishChile", /** - * Represents three-dimensional format 14. + * Spanish Colombian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format14 = "Format14", + spanishColombia = "SpanishColombia", /** - * Represents three-dimensional format 15. + * Spanish Costa Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format15 = "Format15", + spanishCostaRica = "SpanishCostaRica", /** - * Represents three-dimensional format 16. + * Spanish Dominican Republic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format16 = "Format16", + spanishDominicanRepublic = "SpanishDominicanRepublic", /** - * Represents three-dimensional format 17. + * Spanish Ecuadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format17 = "Format17", + spanishEcuador = "SpanishEcuador", /** - * Represents three-dimensional format 18. + * Spanish El Salvadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format18 = "Format18", + spanishElSalvador = "SpanishElSalvador", /** - * Represents three-dimensional format 19. + * Spanish Guatemala language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format19 = "Format19", + spanishGuatemala = "SpanishGuatemala", /** - * Represents three-dimensional format 20. + * Spanish Honduran language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format20 = "Format20", - } - /** - * Specifies the type of the {@link Word.ReflectionFormat} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReflectionType { + spanishHonduras = "SpanishHonduras", /** - * Represents a mixed reflection type. + * Spanish Modern Sort language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + spanishModernSort = "SpanishModernSort", /** - * Represents no reflection. + * Spanish Nicaraguan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + spanishNicaragua = "SpanishNicaragua", /** - * Represents reflection type 1. + * Spanish Panamanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + spanishPanama = "SpanishPanama", /** - * Represents reflection type 2. + * Spanish Paraguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + spanishParaguay = "SpanishParaguay", /** - * Represents reflection type 3. + * Spanish Peruvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + spanishPeru = "SpanishPeru", /** - * Represents reflection type 4. + * Spanish Puerto Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + spanishPuertoRico = "SpanishPuertoRico", /** - * Represents reflection type 5. + * Spanish Uruguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + spanishUruguay = "SpanishUruguay", /** - * Represents reflection type 6. + * Spanish Venezuelan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + spanishVenezuela = "SpanishVenezuela", /** - * Represents reflection type 7. + * Sutu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + sutu = "Sutu", /** - * Represents reflection type 8. + * Swahili language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + swahili = "Swahili", /** - * Represents reflection type 9. + * Swedish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", - } - /** - * Specifies the type of shadowing effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowStyle { + swedish = "Swedish", /** - * Represents a mixed shadow style. + * Swedish Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + swedishFinland = "SwedishFinland", /** - * Represents an outer shadow style. + * Swiss French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outerShadow = "OuterShadow", + swissFrench = "SwissFrench", /** - * Represents an inner shadow style. + * Swiss German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - innerShadow = "InnerShadow", - } - /** - * Specifies the type of shadow displayed with a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowType { + swissGerman = "SwissGerman", /** - * Represents a mixed shadow type. + * Swiss Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + swissItalian = "SwissItalian", /** - * Represents shadow type 1. + * Syriac language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + syriac = "Syriac", /** - * Represents shadow type 2. + * Tajik language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + tajik = "Tajik", /** - * Represents shadow type 3. + * Tamazight language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + tamazight = "Tamazight", /** - * Represents shadow type 4. + * Tamazight Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + tamazightLatin = "TamazightLatin", /** - * Represents shadow type 5. + * Tamil language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + tamil = "Tamil", /** - * Represents shadow type 6. + * Tatar language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + tatar = "Tatar", /** - * Represents shadow type 7. + * Telugu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + telugu = "Telugu", /** - * Represents shadow type 8. + * Thai language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + thai = "Thai", /** - * Represents shadow type 9. + * Tibetan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", + tibetan = "Tibetan", /** - * Represents shadow type 10. + * Tigrigna Eritrea language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type10 = "Type10", + tigrignaEritrea = "TigrignaEritrea", /** - * Represents shadow type 11. + * Tigrigna Ethiopic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type11 = "Type11", + tigrignaEthiopic = "TigrignaEthiopic", /** - * Represents shadow type 12. + * Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type12 = "Type12", + traditionalChinese = "TraditionalChinese", /** - * Represents shadow type 13. + * Tsonga language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type13 = "Type13", + tsonga = "Tsonga", /** - * Represents shadow type 14. + * Tswana language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type14 = "Type14", + tswana = "Tswana", /** - * Represents shadow type 15. + * Turkish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type15 = "Type15", + turkish = "Turkish", /** - * Represents shadow type 16. + * Turkmen language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type16 = "Type16", + turkmen = "Turkmen", /** - * Represents shadow type 17. + * Ukrainian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type17 = "Type17", + ukrainian = "Ukrainian", /** - * Represents shadow type 18. + * Urdu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type18 = "Type18", + urdu = "Urdu", /** - * Represents shadow type 19. + * Uzbek Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type19 = "Type19", + uzbekCyrillic = "UzbekCyrillic", /** - * Represents shadow type 20. + * Uzbek Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type20 = "Type20", + uzbekLatin = "UzbekLatin", /** - * Represents shadow type 21. + * Venda language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type21 = "Type21", + venda = "Venda", /** - * Represents shadow type 22. + * Vietnamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type22 = "Type22", + vietnamese = "Vietnamese", /** - * Represents shadow type 23. + * Welsh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type23 = "Type23", + welsh = "Welsh", /** - * Represents shadow type 24. + * Xhosa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type24 = "Type24", + xhosa = "Xhosa", /** - * Represents shadow type 25. + * Yi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type25 = "Type25", + yi = "Yi", /** - * Represents shadow type 26. + * Yiddish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type26 = "Type26", + yiddish = "Yiddish", /** - * Represents shadow type 27. + * Yoruba language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type27 = "Type27", + yoruba = "Yoruba", /** - * Represents shadow type 28. + * Zulu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type28 = "Type28", + zulu = "Zulu", + } + /** + * Specifies how a building block is inserted into a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocPartInsertType { /** - * Represents shadow type 29. + * Inserts the content of the building block. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type29 = "Type29", + content = "Content", /** - * Represents shadow type 30. + * Inserts the building block as a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type30 = "Type30", + paragraph = "Paragraph", /** - * Represents shadow type 31. + * Inserts the building block as a page. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type31 = "Type31", + page = "Page", + } + /** + * Specifies the type of building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BuildingBlockType { /** - * Represents shadow type 32. + * Represents Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type32 = "Type32", + quickParts = "QuickParts", /** - * Represents shadow type 33. + * Represents Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type33 = "Type33", + coverPage = "CoverPage", /** - * Represents shadow type 34. + * Represents Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type34 = "Type34", + equations = "Equations", /** - * Represents shadow type 35. + * Represents Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type35 = "Type35", + footers = "Footers", /** - * Represents shadow type 36. + * Represents Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type36 = "Type36", + headers = "Headers", /** - * Represents shadow type 37. + * Represents Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type37 = "Type37", + pageNumber = "PageNumber", /** - * Represents shadow type 38. + * Represents Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type38 = "Type38", + tables = "Tables", /** - * Represents shadow type 39. + * Represents Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type39 = "Type39", + watermarks = "Watermarks", /** - * Represents shadow type 40. + * Represents AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type40 = "Type40", + autoText = "AutoText", /** - * Represents shadow type 41. + * Represents Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type41 = "Type41", + textBox = "TextBox", /** - * Represents shadow type 42. + * Represents Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type42 = "Type42", + pageNumberTop = "PageNumberTop", /** - * Represents shadow type 43. + * Represents Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type43 = "Type43", - } - /** - * Specifies the stylistic set to apply to the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum StylisticSet { + pageNumberBottom = "PageNumberBottom", /** - * Default stylistic set. + * Represents Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + pageNumberPage = "PageNumberPage", /** - * Stylistic set 01. + * Represents Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set01 = "Set01", + tableOfContents = "TableOfContents", /** - * Stylistic set 02. + * Represents Custom Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set02 = "Set02", + customQuickParts = "CustomQuickParts", /** - * Stylistic set 03. + * Represents Custom Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set03 = "Set03", + customCoverPage = "CustomCoverPage", /** - * Stylistic set 04. + * Represents Custom Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set04 = "Set04", + customEquations = "CustomEquations", /** - * Stylistic set 05. + * Represents Custom Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set05 = "Set05", + customFooters = "CustomFooters", /** - * Stylistic set 06. + * Represents Custom Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set06 = "Set06", + customHeaders = "CustomHeaders", /** - * Stylistic set 07. + * Represents Custom Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set07 = "Set07", + customPageNumber = "CustomPageNumber", /** - * Stylistic set 08. + * Represents Custom Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set08 = "Set08", + customTables = "CustomTables", /** - * Stylistic set 09. + * Represents Custom Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set09 = "Set09", + customWatermarks = "CustomWatermarks", /** - * Stylistic set 10. + * Represents Custom AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set10 = "Set10", + customAutoText = "CustomAutoText", /** - * Stylistic set 11. + * Represents Custom Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set11 = "Set11", + customTextBox = "CustomTextBox", /** - * Stylistic set 12. + * Represents Custom Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set12 = "Set12", + customPageNumberTop = "CustomPageNumberTop", /** - * Stylistic set 13. + * Represents Custom Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set13 = "Set13", + customPageNumberBottom = "CustomPageNumberBottom", /** - * Stylistic set 14. + * Represents Custom Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set14 = "Set14", + customPageNumberPage = "CustomPageNumberPage", /** - * Stylistic set 15. + * Represents Custom Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set15 = "Set15", + customTableOfContents = "CustomTableOfContents", /** - * Stylistic set 16. + * Represents Custom building block type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set16 = "Set16", + custom1 = "Custom1", /** - * Stylistic set 17. + * Represents Custom building block type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set17 = "Set17", + custom2 = "Custom2", /** - * Stylistic set 18. + * Represents Custom building block type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set18 = "Set18", + custom3 = "Custom3", /** - * Stylistic set 19. + * Represents Custom building block type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set19 = "Set19", + custom4 = "Custom4", /** - * Stylistic set 20. + * Represents Custom building block type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set20 = "Set20", + custom5 = "Custom5", + /** + * Represents Bibliography building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography = "Bibliography", + /** + * Represents Custom Bibliography building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customBibliography = "CustomBibliography", } /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Represents the type of a {@link Word.CustomXmlValidationError}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureAlignment { + enum CustomXmlValidationErrorType { /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents a validation error generated by the schema. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + schemaGenerated = "schemaGenerated", /** - * Aligns the texture to the top-left corner of the shape. + * Represents a validation error that is automatically cleared. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + automaticallyCleared = "automaticallyCleared", /** - * Aligns the texture to the top center of the shape. + * Represents a validation error that is manually created. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + manual = "manual", + } + /** + * Represents the type of a {@link Word.CustomXmlNode}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlNodeType { /** - * Aligns the texture to the top-right corner of the shape. + * Represents an XML element node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + element = "element", /** - * Aligns the texture to the middle left side of the shape. + * Represents an XML attribute node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + attribute = "attribute", /** - * Aligns the texture to the center of the shape. + * Represents an XML text node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + text = "text", /** - * Aligns the texture to the middle right side of the shape. + * Represents an XML CDATA section node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + cData = "cData", /** - * Aligns the texture to the bottom-left corner of the shape. + * Represents an XML processing instruction node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + processingInstruction = "processingInstruction", /** - * Aligns the texture to the bottom center of the shape. + * Represents an XML comment node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + comment = "comment", /** - * Aligns the texture to the bottom-right corner of the shape. + * Represents an XML document node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + document = "document", } /** - * Specifies the texture type for the selected fill. + * Specifies the type of link. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureType { + enum LinkType { /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * OLE object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + ole = "Ole", /** - * A predefined texture selected from the built-in texture gallery. + * Picture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preset = "Preset", + picture = "Picture", /** - * A custom texture defined by the user, typically from an image file. + * Text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - userDefined = "UserDefined", - } - /** - * Specifies the theme colors for document themes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ThemeColorIndex { - /** - * Not a theme color. Used when the color is not part of the theme. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - notThemeColor = "NotThemeColor", + text = "Text", /** - * The first dark color in the main theme. + * Reference library. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark1 = "MainDark1", + reference = "Reference", /** - * The first light color in the main theme. + * Include file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight1 = "MainLight1", + include = "Include", /** - * The second dark color in the main theme. + * Import file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark2 = "MainDark2", + import = "Import", /** - * The second light color in the main theme. + * Dynamic Data Exchange. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight2 = "MainLight2", + dde = "Dde", /** - * The first accent color in the theme. + * Automatic DDE. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent1 = "Accent1", + ddeAuto = "DdeAuto", /** - * The second accent color in the theme. + * Microsoft Excel chart. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent2 = "Accent2", + chart = "Chart", + } + /** + * Specifies the action associated with the verb that the OLE object should perform. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OleVerb { /** - * The third accent color in the theme. + * Performs the verb that is invoked when the user double-clicks the object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent3 = "Accent3", + primary = "Primary", /** - * The fourth accent color in the theme. + * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent4 = "Accent4", + show = "Show", /** - * The fifth accent color in the theme. + * Opens the object in a separate window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent5 = "Accent5", + open = "Open", /** - * The sixth accent color in the theme. + * Removes the object's user interface from view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent6 = "Accent6", + hide = "Hide", /** - * The color used for hyperlinks. + * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + uiActivate = "UiActivate", /** - * The color used for followed hyperlinks. + * Runs the object and installs its window, but doesn't install any user-interface tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinkFollowed = "HyperlinkFollowed", + inPlaceActivate = "InPlaceActivate", /** - * The first background color in the theme. + * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background1 = "Background1", + discardUndoState = "DiscardUndoState", + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListFormat 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; /** - * The first text color in the theme. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text1 = "Text1", + readonly list: Word.List; /** - * The second background color in the theme. + * Gets the list template associated with the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background2 = "Background2", + readonly listTemplate: Word.ListTemplate; /** - * The second text color in the theme. + * Indicates whether the `ListFormat` object contains a single list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text2 = "Text2", - } - /** - * Specifies the hyperlink type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum HyperlinkType { + readonly isSingleList: boolean; /** - * Represents a hyperlink to a range in the document. + * Indicates whether the `ListFormat` object contains a single list template. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range = "Range", + readonly isSingleListTemplate: boolean; /** - * Represents a hyperlink to a shape in the document. + * Specifies the list level number for the first paragraph for the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + listLevelNumber: number; /** - * Represents a hyperlink to an inline shape in the document. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Bibliography 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; + readonly listString: string; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sources: Word.SourceCollection; + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle: string; + readonly listValue: 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.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bibliography): void; + set(properties: Word.ListFormat): void; /** - * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * Adds bullets and formatting to the paragraphs in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - generateUniqueTag(): OfficeExtension.ClientResult; - /** - * 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. + * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds bullets and formatting to the paragraphs in the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.Bibliography; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @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.Bibliography; - /** - * 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.Bibliography; - /** - * 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.Bibliography; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - toJSON(): Word.Interfaces.BibliographyData; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class SourceCollection 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.Source[]; + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Adds a new `Source` object to the collection. + * Applies a list template with a specific level to the paragraphs in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param xml - A string containing the XML data for the source. - * @returns A `Source` object that was added to the collection. + * @param listTemplate - The list template to apply. + * @param options - Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - add(xml: string): Word.Source; + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; /** - * Gets a `Source` by its index in the collection. + * Adds numbering and formatting to the paragraphs in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index - A number that identifies the index location of a `Source` object. + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - getItem(index: number): Word.Source; + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds numbering and formatting to the paragraphs in the range. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds outline numbering and formatting to the paragraphs in the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - load(propertyNames?: string | string[]): Word.SourceCollection; + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds outline numbering and formatting to the paragraphs in the range. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * 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. + * Determines whether the `ListFormat` object can continue a previous list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param listTemplate - The list template to check. + * @returns A `Continue` value indicating whether continuation is possible. */ - track(): Word.SourceCollection; + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; /** - * 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. + * Converts numbers in the list to plain text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType - Optional. The type of number to convert. */ - untrack(): Word.SourceCollection; + convertNumbersToText(numberType: Word.NumberType): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Converts numbers in the list to plain text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType - Optional. The type of number to convert. */ - toJSON(): Word.Interfaces.SourceCollectionData; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Source 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; + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Gets if the `Source` object has been cited in the document. + * Counts the numbered items in the list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Options for counting numbered items, such as the type of number and the level to count. + * @returns The number of items. */ - readonly isCited: boolean; + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Gets the tag of the source. + * Indents the list by one level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly tag: string; + listIndent(): void; /** - * Gets the XML representation of the source. + * Outdents the list by one level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xml: string; + listOutdent(): void; /** - * Deletes the `Source` object. + * Removes numbering from the list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of number to remove. */ - delete(): void; + removeNumbers(numberType: Word.NumberType): void; /** - * Returns the value of a field in the bibliography `Source` object. + * Removes numbering from the list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param name - The name of the field to retrieve. + * @param numberType - Optional. The type of number to remove. */ - getFieldByName(name: string): OfficeExtension.ClientResult; + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): 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.SourceLoadOptions): Word.Source; + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; /** * 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.Source; + load(propertyNames?: string | string[]): Word.ListFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -37520,307 +37856,394 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Source; + }): Word.ListFormat; /** * 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.Source; + track(): Word.ListFormat; /** * 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.Source; + untrack(): Word.ListFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.SourceData; + toJSON(): Word.Interfaces.ListFormatData; } /** - * Represents the page setup settings for a Word document or section. + * Represents options for counting numbered items in a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class PageSetup 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; + export interface ListFormatCountNumberedItemsOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * If provided, specifies the level to count. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering: Word.LineNumbering; + level?: number; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textColumns: Word.TextColumnCollection; + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; + } + /** + * Represents options for applying a list template to a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListTemplateApplyOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + * If provided, specifies the level to apply in the list template. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting: boolean; + applyLevel?: number; /** - * Specifies the number of pages for each booklet. + * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets: number; + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * If provided, specifies whether to continue the previous list. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting: boolean; + continuePreviousList?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin: number; + defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; + } + /** + * Represents the fill formatting for a shape or text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class FillFormat 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; /** - * Specifies the number of characters per line in the document grid. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine: number; + readonly backgroundColor: Word.ColorFormat; /** - * Specifies whether the first page has a different header and footer. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter: boolean; + readonly foregroundColor: Word.ColorFormat; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance: number; + gradientAngle: number; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter: number; + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Specifies on which side the gutter appears in a document. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + readonly gradientDegree: number; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies the distance between the header and the top of the page in points. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance: number; + readonly gradientVariant: number; /** - * Specifies the layout mode for the current document. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + isVisible: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin: number; + readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies the number of lines per page in the document grid. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage: number; + readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins: boolean; + readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter: boolean; + rotateWithObject: boolean; /** - * Specifies the orientation of the page. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.PageOrientation | "Portrait" | "Landscape"; + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the page height in points. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight: number; + textureHorizontalScale: number; /** - * Specifies the page width in points. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth: number; + readonly textureName: string; /** - * Specifies the paper size of the page. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + textureOffsetX: number; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin: number; + textureOffsetY: number; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + textureTile: boolean; /** - * Specifies the type of section break for the specified object. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies whether to show the grid. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid: boolean; + textureVerticalScale: number; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes: boolean; + transparency: number; /** - * Specifies the top margin of the page in points. + * Gets the fill format type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin: number; + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; /** - * Specifies whether to print two pages per sheet. + * 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.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.FillFormat): void; + /** + * Sets the fill to a one-color gradient. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style - The gradient style. + * @param variant - The gradient variant. Can be a value from 1 to 4. + * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - twoPagesOnOne: boolean; + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Sets the fill to a one-color gradient. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style - The gradient style. + * @param variant - The gradient variant. Can be a value from 1 to 4. + * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - /** - * 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.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PageSetup): void; + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; /** - * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * Sets the fill to a pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setAsTemplateDefault(): void; + setPatterned(pattern: Word.PatternType): void; /** - * Switches between portrait and landscape page orientations for a document or section. + * Sets the fill to a pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - togglePortrait(): void; + setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + /** + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + /** + * Sets the fill to a preset texture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setPresetTextured(presetTexture: Word.PresetTexture): void; + /** + * Sets the fill to a preset texture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + /** + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + /** + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + /** + * Sets the fill to a uniform color. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + solid(): 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.FillFormatLoadOptions): Word.FillFormat; /** * 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.PageSetup; + load(propertyNames?: string | string[]): Word.FillFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -37829,91 +38252,75 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.PageSetup; + }): Word.FillFormat; /** * 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.PageSetup; + track(): Word.FillFormat; /** * 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.PageSetup; + untrack(): Word.FillFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.PageSetupData; + toJSON(): Word.Interfaces.FillFormatData; } /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class LineNumbering extends OfficeExtension.ClientObject { + export class GlowFormat 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; /** - * Specifies the numeric increment for line numbers. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - countBy: number; - /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - distanceFromText: number; - /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive: boolean; + readonly color: Word.ColorFormat; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + radius: number; /** - * Specifies the starting line number. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber: number; + transparency: 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.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineNumbering): void; + set(properties: Word.GlowFormat): 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.LineNumberingLoadOptions): Word.LineNumbering; + load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; /** * 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.LineNumbering; + load(propertyNames?: string | string[]): Word.GlowFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -37922,241 +38329,265 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.LineNumbering; + }): Word.GlowFormat; /** * 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.LineNumbering; + track(): Word.GlowFormat; /** * 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.LineNumbering; + untrack(): Word.GlowFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.LineNumberingData; + toJSON(): Word.Interfaces.GlowFormatData; } /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class TextColumnCollection extends OfficeExtension.ClientObject { + export class LineFormat 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.TextColumn[]; /** - * Returns a `TextColumn` object that represents a new text column added to a section or document. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for configuring the new text column. - * @returns A `TextColumn` object that represents a new text column added to the document. */ - add(options?: Word.TextColumnAddOptions): Word.TextColumn; + readonly backgroundColor: Word.ColorFormat; /** - * Gets the direction in which text flows from one text column to the next. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFlowDirection(): OfficeExtension.ClientResult; + readonly foregroundColor: Word.ColorFormat; /** - * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getHasLineBetween(): OfficeExtension.ClientResult; + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Gets whether text columns are evenly spaced. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getIsEvenlySpaced(): OfficeExtension.ClientResult; + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gets a `TextColumn` by its index in the collection. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `TextColumn` object. */ - getItem(index: number): Word.TextColumn; + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Arranges text into the specified number of text columns. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + /** + * Specifies the length of the arrowhead at the end of the line. * - * @param numColumns - The number of columns the text is to be arranged into. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCount(numColumns: number): void; + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Sets the direction in which text flows from one text column to the next. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the end of the line. * - * @param value - The flow direction to set. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setFlowDirection(value: Word.FlowDirection): void; + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Sets the direction in which text flows from one text column to the next. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + insetPen: boolean; + /** + * Specifies if the object, or the formatting applied to it, is visible. * - * @param value - The flow direction to set. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + isVisible: boolean; /** - * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + /** + * Specifies the line format style. * - * @param value - `true` to show vertical lines between columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setHasLineBetween(value: boolean): void; + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Sets whether text columns are evenly spaced. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + transparency: number; + /** + * Specifies the thickness of the line in points. * - * @param value - `true` to evenly space all the text columns in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setIsEvenlySpaced(value: boolean): void; + weight: 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.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineFormat): 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.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; + load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; /** * 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.TextColumnCollection; + load(propertyNames?: string | string[]): Word.LineFormat; /** * 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.TextColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineFormat; /** * 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.TextColumnCollection; + track(): Word.LineFormat; /** * 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.TextColumnCollection; + untrack(): Word.LineFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TextColumnCollectionData; + toJSON(): Word.Interfaces.LineFormatData; } /** - * Represents options for a new text column in a document or section of a document. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TextColumnAddOptions { + export class ReflectionFormat 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; /** - * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEvenlySpaced?: boolean; + blur: number; /** - * If provided, specifies the spacing between the text columns in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + offset: number; /** - * If provided, specifies the width of the new text column in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TextColumn 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; + size: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter: number; + transparency: number; /** - * Specifies the width, in points, of the specified text columns. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width: number; + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; /** * 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.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextColumn): void; + set(properties: Word.ReflectionFormat): 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.TextColumnLoadOptions): Word.TextColumn; + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; /** * 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.TextColumn; + load(propertyNames?: string | string[]): Word.ReflectionFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -38165,5392 +38596,4742 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TextColumn; + }): Word.ReflectionFormat; /** * 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.TextColumn; + track(): Word.ReflectionFormat; /** * 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.TextColumn; + untrack(): Word.ReflectionFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TextColumnData; + toJSON(): Word.Interfaces.ReflectionFormatData; } /** - * Specifies the case of the text in the specified range. + * Represents the color formatting of a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CharacterCase { + export class ColorFormat 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; /** - * Specifies the next case. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + brightness: number; /** - * Specifies lowercase. + * Specifies the theme color for a color format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lower = "Lower", + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies uppercase. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upper = "Upper", + rgb: string; /** - * Specifies title case for each word. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleWord = "TitleWord", + tintAndShade: number; /** - * Specifies title case for the sentence. + * Returns the shape color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleSentence = "TitleSentence", + readonly type: Word.ColorType | "rgb" | "scheme"; /** - * Specifies toggle case. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - toggle = "Toggle", + set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ColorFormat): void; /** - * Specifies half-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - halfWidth = "HalfWidth", + load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; /** - * Specifies full-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fullWidth = "FullWidth", + load(propertyNames?: string | string[]): Word.ColorFormat; /** - * Specifies Katakana characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - katakana = "Katakana", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ColorFormat; /** - * Specifies Hiragana characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - hiragana = "Hiragana", - } - /** - * Specifies the character width of the text in the specified range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CharacterWidth { + track(): Word.ColorFormat; /** - * Specifies half-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - half = "Half", + untrack(): Word.ColorFormat; /** - * Specifies full-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - full = "Full", + toJSON(): Word.Interfaces.ColorFormatData; } /** - * Specifies the seek view options in a Word document. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SeekView { + export class ShadowFormat 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; /** - * Main document. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDocument = "MainDocument", + readonly foregroundColor: Word.ColorFormat; /** - * Primary header. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + blur: number; /** - * First page header. + * Specifies whether the object or the formatting applied to it is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + isVisible: boolean; /** - * Even pages header. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + obscured: boolean; /** - * Primary footer. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + offsetX: number; /** - * First page footer. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + offsetY: number; /** - * Even pages footer. + * Specifies whether to rotate the shadow when rotating the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + rotateWithShape: boolean; /** - * Footnotes. + * Specifies the width of the shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + size: number; /** - * Endnotes. + * Specifies the type of shadow formatting to apply to a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Current page header. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + transparency: number; /** - * Current page footer. + * Specifies the shape shadow type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", - } - /** - * Specifies the source documents to show. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShowSourceDocuments { + type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; /** - * Specifies that no source documents are shown. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShadowFormat): void; /** - * Specifies that the original source document is shown. + * Changes the horizontal offset of the shadow by the number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + incrementOffsetX(increment: number): void; /** - * Specifies that the revised source document is shown. + * Changes the vertical offset of the shadow by the specified number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revised = "Revised", + incrementOffsetY(increment: number): void; /** - * Specifies that both the original and revised source documents are shown. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - both = "Both", - } - /** - * Specifies the special pane options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SpecialPane { + load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; /** - * None. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + * 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.ShadowFormat; /** - * Primary header. + * 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.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShadowFormatData; + } + /** + * Represents a shape's three-dimensional formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ThreeDimensionalFormat 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; + /** + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + readonly contourColor: Word.ColorFormat; /** - * First page header. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + readonly extrusionColor: Word.ColorFormat; /** - * Even pages header. + * Specifies the depth of the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + bevelBottomDepth: number; /** - * Primary footer. + * Specifies the inset size for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + bevelBottomInset: number; /** - * First page footer. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Even pages footer. + * Specifies the depth of the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + bevelTopDepth: number; /** - * Footnotes. + * Specifies the inset size for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + bevelTopInset: number; /** - * Endnotes. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Footnote continuation notice. + * Specifies the width of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + contourWidth: number; /** - * Footnote continuation separator. + * Specifies the depth of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + depth: number; /** - * Footnote separator. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Endnote continuation notice. + * Specifies the amount of perspective for a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + fieldOfView: number; /** - * Endnote continuation separator. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + isPerspective: boolean; /** - * Endnote separator. + * Specifies if the specified object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + isVisible: boolean; /** - * Comments. + * Specifies the angle of the lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + lightAngle: number; /** - * Current page header. + * Returns a `PresetCamera` value that represents the camera presets. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Current page footer. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Revisions. + * Specifies a `LightRigType` value that represents the lighting preset. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisions = "Revisions", + presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Revisions horizontal. + * Specifies the position of the light source relative to the extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsHoriz = "RevisionsHoriz", + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Revisions vertical. + * Specifies the intensity of the extrusion lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsVert = "RevisionsVert", - } - /** - * Specifies the save options. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SaveConfiguration { + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies not to save changes. + * Specifies the extrusion surface material. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doNotSaveChanges = "DoNotSaveChanges", + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Specifies to save changes. + * Returns the preset extrusion format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saveChanges = "SaveChanges", + readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Specifies to prompt to save changes. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - promptToSaveChanges = "PromptToSaveChanges", - } - /** - * Specifies the page color options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageColor { + projectText: boolean; /** - * None. + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + rotationX: number; /** - * Sepia. + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sepia = "Sepia", + rotationY: number; /** - * Inverse. + * Specifies the z-axis rotation of the camera. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inverse = "Inverse", - } - /** - * Specifies the page movement type in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageMovementType { + rotationZ: number; /** - * Vertical. + * Specifies the position on the z-axis for the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + z: number; /** - * Side to side. + * 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.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ThreeDimensionalFormat): void; + /** + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sideToSide = "SideToSide", - } - /** - * Specifies the margin options in reading layout view in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingLayoutMargin { + incrementRotationHorizontal(increment: number): void; /** - * Microsoft Word determines automatically whether to show or hide the margins based on the available space. + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "Automatic", + incrementRotationVertical(increment: number): void; /** - * Hides margins. + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppress = "Suppress", + incrementRotationX(increment: number): void; /** - * Shows margins. + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the margin for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonMargin { + incrementRotationY(increment: number): void; /** - * Left margin. + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + incrementRotationZ(increment: number): void; /** - * Right margin. + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", - } - /** - * Specifies the width type for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonWidthType { + resetRotation(): void; /** - * Balloon width as a percentage. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection - The preset direction. */ - percent = "Percent", + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; /** - * Balloon width in points. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection - The preset direction. */ - points = "Points", - } - /** - * Specifies the extent of markup visible in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMarkup { + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; /** - * No markup. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + setPresetCamera(presetCamera: Word.PresetCamera): void; /** - * Simple markup. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", + setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; /** - * All markup. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + /** + * Sets the preset extrusion format. + The preset format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): 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.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ThreeDimensionalFormatData; } /** - * Specifies the display mode for tracked changes in a Word document. + * Specifies the length of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionsMode { + enum ArrowheadLength { /** - * Balloon. + * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloon = "Balloon", + mixed = "Mixed", /** - * Inline. + * Represents a short arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + short = "Short", /** - * Mixed. + * Represents a medium arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + medium = "Medium", + /** + * Represents a long arrowhead length. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + long = "Long", } /** - * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. + * Specifies the style of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionsView { + enum ArrowheadStyle { /** - * Final view. + * Represents a mixed arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - final = "Final", + mixed = "Mixed", /** - * Original view. + * Represents no arrowhead. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", - } - /** - * Specifies the revision type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionType { + none = "None", /** - * No revision. + * Represents a triangle arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + triangle = "Triangle", /** - * Insert revision. + * Represents an open arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insert = "Insert", + open = "Open", /** - * Delete revision. + * Represents a stealth arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete = "Delete", + stealth = "Stealth", /** - * Property revision. + * Represents a diamond arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - property = "Property", + diamond = "Diamond", /** - * Paragraph number revision. + * Represents an oval arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphNumber = "ParagraphNumber", + oval = "Oval", + } + /** + * Specifies the width of the arrowhead at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ArrowheadWidth { /** - * Display field revision. + * Represents a mixed arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - displayField = "DisplayField", + mixed = "Mixed", /** - * Reconcile revision. + * Represents a narrow arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reconcile = "Reconcile", + narrow = "Narrow", /** - * Conflict revision. + * Represents a medium arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflict = "Conflict", + medium = "Medium", /** - * Style revision. + * Represents a wide arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style = "Style", + wide = "Wide", + } + /** + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BevelType { /** - * Replace revision. + * Represents a mixed bevel type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replace = "Replace", + mixed = "mixed", /** - * Paragraph property revision. + * Represents no bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphProperty = "ParagraphProperty", + none = "none", /** - * Table property revision. + * Represents a relaxed inset bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableProperty = "TableProperty", + relaxedInset = "relaxedInset", /** - * Section property revision. + * Represents a circle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionProperty = "SectionProperty", + circle = "circle", /** - * Style definition revision. + * Represents a slope bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleDefinition = "StyleDefinition", + slope = "slope", /** - * Moved from revision. + * Represents a cross bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedFrom = "MovedFrom", + cross = "cross", /** - * Moved to revision. + * Represents an angle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedTo = "MovedTo", + angle = "angle", /** - * Cell insertion revision. + * Represents a soft round bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellInsertion = "CellInsertion", + softRound = "softRound", /** - * Cell deletion revision. + * Represents a convex bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellDeletion = "CellDeletion", + convex = "convex", /** - * Cell merge revision. + * Represents a cool slant bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellMerge = "CellMerge", + coolSlant = "coolSlant", /** - * Cell split revision. + * Represents a divot bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellSplit = "CellSplit", + divot = "divot", /** - * Conflict insert revision. + * Represents a riblet bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictInsert = "ConflictInsert", + riblet = "riblet", /** - * Conflict delete revision. + * Represents a hard edge bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictDelete = "ConflictDelete", - } - /** - * Specifies the column width options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColumnWidth { + hardEdge = "hardEdge", /** - * Narrow column width. + * Represents an art deco bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorIndex { /** - * Default column width. + * Automatically determines the color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + auto = "Auto", /** - * Wide column width. + * Represents the color black. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", - } - /** - * Specifies the field shading options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FieldShading { + black = "Black", /** - * Never shade fields. + * Represents the color blue. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - never = "Never", + blue = "Blue", /** - * Always shade fields. + * Represents the color turquoise. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - always = "Always", + turquoise = "Turquoise", /** - * Shade fields when selected. + * Represents a bright green color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whenSelected = "WhenSelected", - } - /** - * Specifies the format for horizontal text set within vertical text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum HorizontalInVerticalType { + brightGreen = "BrightGreen", /** - * No formatting is applied to the horizontal text. + * Represents the color pink. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + pink = "Pink", /** - * The horizontal text is sized to fit in the line of vertical text. + * Represents the color red. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitInLine = "FitInLine", + red = "Red", /** - * The line of vertical text is sized to accommodate the horizontal text. + * Represents the color yellow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resizeLine = "ResizeLine", - } - /** - * Specifies the IME (Input Method Editor) mode. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ImeMode { + yellow = "Yellow", /** - * Specifies no control over the IME mode. + * Represents the color white. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noControl = "NoControl", + white = "White", /** - * Specifies the IME mode is on. + * Represents a dark blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - on = "On", + darkBlue = "DarkBlue", /** - * Specifies the IME mode is off. + * Represents the color teal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - off = "Off", + teal = "Teal", /** - * Specifies the Hiragana IME mode. + * Represents the color green. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + green = "Green", /** - * Specifies the Katakana (double-byte) IME mode. + * Represents the color violet. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + violet = "Violet", /** - * Specifies the Katakana (half-width) IME mode. + * Represents a dark red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakanaHalf = "KatakanaHalf", + darkRed = "DarkRed", /** - * Specifies the full-width alphanumeric IME mode. + * Represents a dark yellow color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphaFull = "AlphaFull", + darkYellow = "DarkYellow", /** - * Specifies the half-width alphanumeric IME mode. + * Represents a gray color with 50% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alpha = "Alpha", + gray50 = "Gray50", /** - * Specifies the full-width Hangul IME mode. + * Represents a gray color with 25% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangulFull = "HangulFull", + gray25 = "Gray25", /** - * Specifies the half-width Hangul IME mode. + * Represents a classic red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangul = "Hangul", - } - /** - * Specifies the Kana type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Kana { + classicRed = "ClassicRed", /** - * Katakana Kana type. + * Represents a classic blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + classicBlue = "ClassicBlue", /** - * Hiragana Kana type. + * Represents a color determined by the author. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + byAuthor = "ByAuthor", } /** - * Specifies the two lines in one type. + * Specifies the color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TwoLinesInOneType { - /** - * No two lines in one. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + enum ColorType { /** - * Two lines in one without brackets. + * Represents an RGB color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noBrackets = "NoBrackets", + rgb = "rgb", /** - * Two lines in one with parentheses. + * Represents a scheme color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentheses = "Parentheses", + scheme = "scheme", + } + /** + * Specifies whether the formatting from the previous list can be continued. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Continue { /** - * Two lines in one with square brackets. + * Formatting cannot continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareBrackets = "SquareBrackets", + disabled = "Disabled", /** - * Two lines in one with angle brackets. + * Formatting can continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angleBrackets = "AngleBrackets", + list = "List", /** - * Two lines in one with curly brackets. + * Numbering can be restarted. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - curlyBrackets = "CurlyBrackets", + reset = "Reset", } /** - * Specifies the underline type. + * Specifies the default list behavior for a list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum Underline { + enum DefaultListBehavior { /** - * No underline. + * Use formatting compatible with Microsoft Word 97. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + word97 = "Word97", /** - * Single underline. + * Use Web-oriented formatting as introduced in Microsoft Word 2000. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + word2000 = "Word2000", /** - * Underline words only. + * Use formatting compatible with Microsoft Word 2002. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - words = "Words", + word2002 = "Word2002", + } + /** + * Specifies the type of emphasis mark to use for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EmphasisMark { /** - * Double underline. + * No emphasis mark. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + none = "None", /** - * Dotted underline. + * Emphasis mark over a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotted = "Dotted", + overSolidCircle = "OverSolidCircle", /** - * Thick underline. + * Emphasis mark over a comma. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thick = "Thick", + overComma = "OverComma", /** - * Dash underline. + * Emphasis mark over a white circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + overWhiteCircle = "OverWhiteCircle", /** - * Dot dash underline. + * Emphasis mark under a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDash = "DotDash", + underSolidCircle = "UnderSolidCircle", + } + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExtrusionColorType { /** - * Dot dot dash underline. + * Represents a mixed extrusion color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDash = "DotDotDash", + mixed = "mixed", /** - * Wavy underline. + * Represents an automatic extrusion color based on the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavy = "Wavy", + automatic = "automatic", /** - * Heavy wavy underline. + * Represents a custom extrusion color independent of the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavyHeavy = "WavyHeavy", + custom = "custom", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FillType { /** - * Heavy dotted underline. + * Represents a mixed fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedHeavy = "DottedHeavy", + mixed = "Mixed", /** - * Heavy dash underline. + * Represents a solid fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashHeavy = "DashHeavy", + solid = "Solid", /** - * Heavy dot dash underline. + * Represents a patterned fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDashHeavy = "DotDashHeavy", + patterned = "Patterned", /** - * Heavy dot dot dash underline. + * Represents a gradient fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDashHeavy = "DotDotDashHeavy", + gradient = "Gradient", /** - * Long dash underline. + * Represents a textured fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLong = "DashLong", + textured = "Textured", /** - * Heavy long dash underline. + * Represents a background fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLongHeavy = "DashLongHeavy", + background = "Background", /** - * Double wavy underline. + * Represents a picture fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavyDouble = "WavyDouble", + picture = "Picture", } /** - * Specifies the view type in a Word document. + * Specifies the type of gradient used in a shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ViewType { + enum GradientColorType { /** - * Normal. + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + mixed = "Mixed", /** - * Outline. + * Gradient with a single color and varying transparency or brightness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline = "Outline", + oneColor = "OneColor", /** - * Print. + * Gradient that blends two distinct colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - print = "Print", + twoColors = "TwoColors", /** - * Print preview. + * Gradient that uses a predefined set of colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - printPreview = "PrintPreview", + presetColors = "PresetColors", /** - * Master. + * Gradient that includes more than two colors, often customized. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - master = "Master", + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientStyle { /** - * Web. + * Represents a mixed gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web = "Web", + mixed = "Mixed", /** - * Reading. + * Represents a horizontal gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading = "Reading", + horizontal = "Horizontal", /** - * Conflict. + * Represents a vertical gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflict = "Conflict", - } - /** - * Represents the state of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowState { + vertical = "Vertical", /** - * Represents the normal state of the window. + * Represents a diagonal-up gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + diagonalUp = "DiagonalUp", /** - * Represents the maximized state of the window. + * Represents a diagonal-down gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - maximize = "Maximize", + diagonalDown = "DiagonalDown", /** - * Represents the minimized state of the window. + * Represents a gradient style from the corner. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - minimize = "Minimize", - } - /** - * Specifies the type of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowType { + fromCorner = "FromCorner", /** - * Specifies a document window. + * Represents a gradient style from the title. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "Document", + fromTitle = "FromTitle", /** - * Specifies a template window. + * Represents a gradient style from the center. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + fromCenter = "FromCenter", } /** - * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. + * Specifies the type of ligature applied to a font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface SelectionConvertToTableOptions { + enum Ligature { /** - * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. - * + * No ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyBorders?: boolean; + none = "None", /** - * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. - * + * Standard ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyColor?: boolean; + standard = "Standard", /** - * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. - * + * Contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFirstColumn?: boolean; + contextual = "Contextual", /** - * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. - * + * Standard and contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFont?: boolean; + standardContextual = "StandardContextual", /** - * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. - * + * Historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyHeadingRows?: boolean; + historical = "Historical", /** - * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. - * + * Standard and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastColumn?: boolean; + standardHistorical = "StandardHistorical", /** - * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. - * + * Contextual and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastRow?: boolean; + contextualHistorical = "ContextualHistorical", /** - * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. - * + * Standard, contextual, and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyShading?: boolean; + standardContextualHistorical = "StandardContextualHistorical", /** - * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. - * + * Discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit?: boolean; + discretional = "Discretional", /** - * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. - * + * Standard and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; + standardDiscretional = "StandardDiscretional", /** - * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. - * + * Contextual and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; + contextualDiscretional = "ContextualDiscretional", /** - * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. - * + * Standard, contextual, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + standardContextualDiscretional = "StandardContextualDiscretional", /** - * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. - * + * Historical and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - initialColumnWidth?: number; + historicalDiscretional = "HistoricalDiscretional", /** - * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. - * + * Standard, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numColumns?: number; + standardHistoricalDiscretional = "StandardHistoricalDiscretional", /** - * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. - * + * Contextual, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numRows?: number; + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", /** - * If provided, specifies the character used to separate text into cells. The default value is `-`. - * + * All ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separator?: string; + all = "All", } /** - * Represents the options for the {@link Word.Selection | Selection.delete} method. + * Indicates the effects lighting for an object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface SelectionDeleteOptions { + enum LightRigType { /** - * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. - * + * Represents a mixed light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + mixed = "Mixed", /** - * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. - * + * Represents legacy flat light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.goTo} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionGoToOptions { + legacyFlat1 = "LegacyFlat1", /** - * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. - * + * Represents legacy flat light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + legacyFlat2 = "LegacyFlat2", /** - * If provided, specifies the direction the range or selection is moved to. The default value is `next`. - * + * Represents legacy flat light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; + legacyFlat3 = "LegacyFlat3", /** - * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. - * + * Represents legacy flat light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + legacyFlat4 = "LegacyFlat4", /** - * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. - * + * Represents legacy normal light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionInsertCrossReferenceOptions { + legacyNormal1 = "LegacyNormal1", /** - * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. - * + * Represents legacy normal light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includePosition?: boolean; + legacyNormal2 = "LegacyNormal2", /** - * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. - * + * Represents legacy normal light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsHyperlink?: boolean; + legacyNormal3 = "LegacyNormal3", /** - * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) - * + * Represents legacy normal light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateNumbers?: boolean; + legacyNormal4 = "LegacyNormal4", /** - * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". - * + * Represents legacy harsh light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separatorString?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionInsertDateTimeOptions { + legacyHarsh1 = "LegacyHarsh1", /** - * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents legacy harsh light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; + legacyHarsh2 = "LegacyHarsh2", /** - * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents legacy harsh light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; + legacyHarsh3 = "LegacyHarsh3", /** - * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. - * + * Represents legacy harsh light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateTimeFormat?: string; + legacyHarsh4 = "LegacyHarsh4", /** - * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. - * + * Represents a three-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsField?: boolean; + threePoint = "ThreePoint", /** - * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents a balanced light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsFullWidth?: boolean; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertFormula} method - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionInsertFormulaOptions { + balanced = "Balanced", /** - * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. - The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. - - - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. - - - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. - - - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. - - - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. - * + * Represents a soft light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formula?: string; + soft = "Soft", /** - * If provided, specifies the format for the result of the `= (Formula)` field. - * + * Represents a harsh light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberFormat?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionInsertSymbolOptions { + harsh = "Harsh", /** - * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. - * + * Represents a flood light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; + flood = "Flood", /** - * If provided, specifies the name of the font that contains the symbol. - * + * Represents a contrasting light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - font?: string; + contrasting = "Contrasting", /** - * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. - * + * Represents a morning light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unicode?: boolean; - } - /** - * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionMoveLeftRightOptions { + morning = "Morning", /** - * If provided, specifies the number of units the selection is to be moved. The default value is 1. - * + * Represents a sunrise light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + sunrise = "Sunrise", /** - * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. - * + * Represents a sunset light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend?: Word.MovementType | "Move" | "Extend"; + sunset = "Sunset", /** - * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. - * + * Represents a chilly light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.move} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionMoveOptions { + chilly = "Chilly", /** - * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. - * + * Represents a freezing light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + freezing = "Freezing", /** - * If provided, specifies the unit by which to move the ending character position. The default value is `character`. - * + * Represents a flat light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionMoveStartEndOptions { + flat = "Flat", /** - * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. - * + * Represents a two-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + twoPoint = "TwoPoint", /** - * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. - * + * Represents a glow light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + glow = "Glow", + /** + * Represents a bright room light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + brightRoom = "BrightRoom", } /** - * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. + * Specifies the dash style for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface SelectionMoveUpDownOptions { + enum LineDashStyle { /** - * If provided, specifies the number of units the selection is to be moved. The default value is 1. - * + * Represents a mixed dash style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + mixed = "Mixed", /** - * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. - * + * Represents a solid line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend?: Word.MovementType | "Move" | "Extend"; + solid = "Solid", /** - * If provided, specifies the unit by which to move the selection. The default value is `line`. - * + * Represents a square dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.next} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionNextOptions { + squareDot = "SquareDot", /** - * If provided, specifies the number of units by which you want to move ahead. The default value is 1. - * + * Represents a round dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + roundDot = "RoundDot", /** - * If provided, specifies the type of units by which to move the selection. The default value is `character`. - * + * Represents a dashed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.previous} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SelectionPreviousOptions { + dash = "Dash", /** - * If provided, specifies the number of units by which you want to move. The default value is 1. - * + * Represents a dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + dashDot = "DashDot", /** - * If provided, specifies the type of unit by which to move the selection. The default value is `character`. - * + * Represents a dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents a selected range or the insertion point in a Word document. - - - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Selection 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; + dashDotDot = "DashDotDot", /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. - * + * Represents a long dash line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly borders: Word.BorderUniversalCollection; + longDash = "LongDash", /** - * Returns a `RangeScopedCollection` object that represents each character in the selection. - * + * Represents a long dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly characters: Word.RangeScopedCollection; + longDashDot = "LongDashDot", /** - * Returns a `CommentCollection` object that represents all the comments in the selection. - * + * Represents a long dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: Word.CommentCollection; + longDashDotDot = "LongDashDotDot", /** - * Returns a `FieldCollection` object that represents all the fields in the selection. - * + * Represents a system dash line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fields: Word.FieldCollection; + sysDash = "SysDash", /** - * Returns the `Font` object that represents the character formatting of the selection. - * + * Represents a system dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly font: Word.Font; + sysDot = "SysDot", /** - * Specifies a `Range` object that includes the formatted text in the range or selection. - * + * Represents a system dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formattedText: Word.Range; + sysDashDot = "SysDashDot", + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineFormatStyle { /** - * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. - * + * Represents a mixed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly paragraphs: Word.ParagraphCollection; + mixed = "Mixed", /** - * Returns the `Range` object for the portion of the document contained in the selection. - * + * Represents a single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + single = "Single", /** - * Returns the `SectionCollection` object in the selection. - * + * Represents a thin-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sections: Word.SectionCollection; + thinThin = "ThinThin", /** - * Returns the `RangeScopedCollection` object for each sentence in the selection. - * + * Represents a thin-thick line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sentences: Word.RangeScopedCollection; + thinThick = "ThinThick", /** - * Returns the `ShadingUniversal` object for the shading formatting for the selection. - * + * Represents a thick-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + thickThin = "ThickThin", /** - * Returns the `TableCollection` object in the selection. - * + * Represents a thick line between two thin lines style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly tables: Word.TableCollection; + thickBetweenThin = "ThickBetweenThin", + } + /** + * Specifies the portion of a list to which to apply a list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListApplyTo { /** - * Returns the tables at the outermost nesting level in the current selection. - * + * Applies the list template to the entire list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly topLevelTables: Word.TableCollection; + wholeList = "WholeList", /** - * Returns the `RangeScopedCollection` object that represents each word in the selection. - * + * Applies the list template from the cursor insertion point to the end of the list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly words: Word.RangeScopedCollection; + thisPointForward = "ThisPointForward", /** - * Specifies the ending character position of the selection. - * + * Applies the list template to the selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end: number; + selection = "Selection", + } + /** + * Represents the list type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListType { /** - * Specifies the width in which Word fits the text in the current selection. - * + * List with no bullets, numbering, or outlining. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth: number; + listNoNumbering = "ListNoNumbering", /** - * Returns whether the spelling and grammar checker ignores the selected text. - If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. - * + * ListNum fields that can be used in the body of a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly hasNoProofing: boolean; + listListNumOnly = "ListListNumOnly", /** - * Returns whether the selection in the specified window or pane is active. - * + * Bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isActive: boolean; + listBullet = "ListBullet", /** - * Specifies whether column selection mode is active. - * + * Simple numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isColumnSelectModeActive: boolean; + listSimpleNumbering = "ListSimpleNumbering", /** - * Returns whether the selection is at the end-of-row mark in a table. - * + * Outlined list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isEndOfRowMark: boolean; + listOutlineNumbering = "ListOutlineNumbering", /** - * Specifies whether Extend mode is active. - * + * Mixed numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtendModeActive: boolean; + listMixedNumbering = "ListMixedNumbering", /** - * Returns whether the insertion point is at the end of a line. - * + * Picture bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isInsertionPointAtEndOfLine: boolean; + listPictureBullet = "ListPictureBullet", + } + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberForm { /** - * Specifies whether the beginning of the selection is active. - * + * Default number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive: boolean; + default = "Default", /** - * Specifies whether Word has detected the language of the selected text. - * + * Lining number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected: boolean; + lining = "Lining", /** - * Returns the language for the selection. - * + * Old-style number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + oldStyle = "OldStyle", + } + /** + * Specifies the number spacing setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberSpacing { /** - * Returns the East Asian language for the selection. - * + * Default number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + default = "Default", /** - * Returns the language for the selection that isn't classified as an East Asian language. - * + * Proportional number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + proportional = "Proportional", /** - * Specifies the orientation of text in the selection. - * + * Tabular number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + tabular = "Tabular", + } + /** + * Specifies the type of numbers in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberType { /** - * Specifies the starting character position of the selection. - * + * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start: number; + paragraph = "Paragraph", /** - * Returns the number of characters in the story that contains the selection. - * + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyLength: number; + listNum = "ListNum", /** - * Returns the story type for the selection. - * + * Default value for all other cases. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + allNumbers = "AllNumbers", + } + /** + * Specifies the fill pattern used in a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PatternType { /** - * Specifies the text in the selection. - * + * Represents a mixed pattern type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text: string; + mixed = "Mixed", /** - * Returns the selection type. - * + * Represents a 5 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + percent5 = "Percent5", /** - * Calculates the first mathematical expression within the selection. - * + * Represents a 10 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The result of the calculation. */ - calculate(): OfficeExtension.ClientResult; + percent10 = "Percent10", /** - * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. - * + * Represents a 20 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cancelMode(): void; + percent20 = "Percent20", /** - * Removes character formatting applied through character styles. - * + * Represents a 25 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearCharacterStyleFormatting(): void; + percent25 = "Percent25", /** - * Removes character and paragraph formatting from the selection. - * + * Represents a 30 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearFormatting(): void; + percent30 = "Percent30", /** - * Removes manually applied character formatting from the selected text. - * + * Represents a 40 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearManualCharacterFormatting(): void; + percent40 = "Percent40", /** - * Removes manually applied paragraph formatting from the selected text. - * + * Represents a 50 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearManualParagraphFormatting(): void; + percent50 = "Percent50", /** - * Removes all paragraph formatting from the selected text. - * + * Represents a 60 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearParagraphFormatting(): void; + percent60 = "Percent60", /** - * Removes paragraph formatting applied through paragraph styles. - * + * Represents a 70 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearParagraphStyle(): void; + percent70 = "Percent70", /** - * Collapses the selection to the starting or ending position. - * + * Represents a 75 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param direction - Optional. Direction to collapse. */ - collapse(direction?: Word.CollapseDirection): void; + percent75 = "Percent75", /** - * Collapses the selection to the starting or ending position. - * + * Represents an 80 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param direction - Optional. Direction to collapse. */ - collapse(direction?: "Start" | "End"): void; + percent80 = "Percent80", /** - * Converts text within a range to a table. - * + * Represents a 90 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for converting text to a table. - * @returns A `Table` object that represents the newly created table. */ - convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + percent90 = "Percent90", /** - * Copies the selection to the Clipboard as a picture. - * + * Represents a dark horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyAsPictureToClipboard(): void; + darkHorizontal = "DarkHorizontal", /** - * Copies the character formatting of the first character in the selected text. - * + * Represents a dark vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyFormat(): void; + darkVertical = "DarkVertical", /** - * Copies the selection to the Clipboard. - * + * Represents a dark downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyToClipboard(): void; + darkDownwardDiagonal = "DarkDownwardDiagonal", /** - * Adds a default-sized text box around the selection. - * + * Represents a dark upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - createTextBox(): void; + darkUpwardDiagonal = "DarkUpwardDiagonal", /** - * Removes the selected content from the document and moves it to the Clipboard. - * + * Represents a small checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + smallCheckerBoard = "SmallCheckerBoard", /** - * Deletes the specified number of characters or words. - * + * Represents a trellis fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for deleting text. - * @returns The number of characters deleted. */ - delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + trellis = "Trellis", /** - * Analyzes the selected text to determine the language that it's written in. - * + * Represents a light horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): void; + lightHorizontal = "LightHorizontal", /** - * Expands the selection. - * + * Represents a light vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param unit - Optional. The unit to expand. - * @returns The number of characters added to the range or selection. */ - expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + lightVertical = "LightVertical", /** - * Expands the selection. - * + * Represents a light downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param unit - Optional. The unit to expand. - * @returns The number of characters added to the range or selection. */ - expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + lightDownwardDiagonal = "LightDownwardDiagonal", /** - * Expands the selection to include the entire story. - * + * Represents a light upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expandToWholeStory(): void; + lightUpwardDiagonal = "LightUpwardDiagonal", /** - * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. - * + * Represents a small grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ - extend(character?: Word.OperationUnit): void; + smallGrid = "SmallGrid", /** - * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. - * + * Represents a dotted diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ - extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + dottedDiamond = "DottedDiamond", /** - * Returns a `Range` object that represents the next unit relative to the selection. - * + * Represents a wide downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for the `next` operation. - * @returns A `Range` object that represents the next unit relative to the selection. */ - getNextRange(options?: Word.SelectionNextOptions): Word.Range; + wideDownwardDiagonal = "WideDownwardDiagonal", /** - * Returns a `Range` object that represents the previous unit relative to the selection. - * + * Represents a wide upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for the `previous` operation. - * @returns A `Range` object that represents the previous unit relative to the selection. */ - getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + wideUpwardDiagonal = "WideUpwardDiagonal", /** - * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. - * + * Represents a dashed upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for the `goTo` operation. - * @returns A `Range` object that is now selected. */ - goTo(options?: Word.SelectionGoToOptions): Word.Range; + dashedUpwardDiagonal = "DashedUpwardDiagonal", /** - * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a dashed downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what - The item type to go to. - * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. */ - goToNext(what: Word.GoToItem): Word.Range; + dashedDownwardDiagonal = "DashedDownwardDiagonal", /** - * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a narrow vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what - The item type to go to. - * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. */ - goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + narrowVertical = "NarrowVertical", /** - * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a narrow horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what - The item type to go to. - * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. */ - goToPrevious(what: Word.GoToItem): Word.Range; + narrowHorizontal = "NarrowHorizontal", /** - * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a dashed vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what - The item type to go to. - * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. */ - goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + dashedVertical = "DashedVertical", /** - * Inserts the specified text at the end of the range or selection. - * + * Represents a dashed horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param text - Text to insert. */ - insertAfter(text: string): void; + dashedHorizontal = "DashedHorizontal", /** - * Inserts the specified text before the selection. - * + * Represents a large confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param text - Text to insert. */ - insertBefore(text: string): void; + largeConfetti = "LargeConfetti", /** - * Adds cells to an existing table. - * + * Represents a large grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ - insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + largeGrid = "LargeGrid", /** - * Adds cells to an existing table. - * + * Represents a horizontal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ - insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + horizontalBrick = "HorizontalBrick", /** - * Inserts columns to the left of the column that contains the selection. - * + * Represents a large checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertColumnsLeft(): void; + largeCheckerBoard = "LargeCheckerBoard", /** - * Inserts columns to the right of the current selection. - * + * Represents a small confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertColumnsRight(): void; + smallConfetti = "SmallConfetti", /** - * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. - * + * Represents a zigzag fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Options for inserting the date or time. */ - insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + zigZag = "ZigZag", /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. - * + * Represents a solid diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for inserting the formula. */ - insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + solidDiamond = "SolidDiamond", /** - * Inserts a new page at the position of the insertion point. - * + * Represents a diagonal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertNewPage(): void; + diagonalBrick = "DiagonalBrick", /** - * Inserts a paragraph mark after the selection. - * + * Represents an outlined diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphAfter(): void; + outlinedDiamond = "OutlinedDiamond", /** - * Inserts a new paragraph before the selection or range. - * + * Represents a plaid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphBefore(): void; + plaid = "Plaid", /** - * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. - * + * Represents a sphere fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphStyleSeparator(): void; + sphere = "Sphere", /** - * Inserts rows above the current selection. - * + * Represents a weave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numRows - Optional. Number of rows to insert. */ - insertRowsAbove(numRows: number): void; + weave = "Weave", /** - * Inserts rows below the current selection. - * + * Represents a dotted grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numRows - Optional. Number of rows to insert. */ - insertRowsBelow(numRows: number): void; + dottedGrid = "DottedGrid", /** - * Inserts a symbol in place of the specified selection. - * + * Represents a divot fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characterNumber - The character number of the symbol. - * @param options - Optional. Options for inserting the symbol. */ - insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + divot = "Divot", /** - * Inserts the specified text. - * + * Represents a shingle fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param Text - The text to insert. */ - insertText(Text: string): void; + shingle = "Shingle", /** - * Inserts the specified XML into the document at the cursor, replacing any selected text. - * + * Represents a wave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param xml - The XML string to insert. - * @param transform - Optional. XSL transform to apply. */ - insertXML(xml: string, transform?: string): void; + wave = "Wave", /** - * Returns whether the selection is equal to the specified range. - * + * Represents a horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range to compare. - * @returns `true` if the selection is equal to the specified range. */ - isEqual(range: Word.Range): OfficeExtension.ClientResult; + horizontal = "Horizontal", /** - * Returns `true` if the selection is contained within the specified range. - * + * Represents a vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range to compare. - * @returns `true` if the selection is contained within the specified range. */ - isInRange(range: Word.Range): OfficeExtension.ClientResult; + vertical = "Vertical", /** - * Returns whether the selection is in the same story as the specified range. - * + * Represents a cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range to compare. - * @returns `true` if the selection is in the same story as the specified range. */ - isInStory(range: Word.Range): OfficeExtension.ClientResult; + cross = "Cross", /** - * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. - * + * Represents a downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving the selection. - * @returns The number of characters by which the selection was moved. */ - move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + downwardDiagonal = "DownwardDiagonal", /** - * Moves the selection down. - * + * Represents an upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving down. - * @returns The number of characters by which the selection was moved. */ - moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + upwardDiagonal = "UpwardDiagonal", /** - * Moves the ending character position of the range or selection. - * + * Represents a diagonal cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving end. - * @returns The number of characters by which the selection was moved. */ - moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + diagonalCross = "DiagonalCross", + } + /** + * Indicates the effects camera type used by the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetCamera { /** - * Moves the end position of the selection until any of the specified characters are found in the document. - * + * Represents a mixed camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + mixed = "Mixed", /** - * Moves the ending character position of the selection while any of the specified characters are found in the document. - * + * Represents a legacy oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + legacyObliqueTopLeft = "LegacyObliqueTopLeft", /** - * Moves the selection to the left. - * + * Represents a legacy oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving left. - * @returns The number of characters by which the selection was moved. */ - moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + legacyObliqueTop = "LegacyObliqueTop", /** - * Moves the selection to the right. - * + * Represents a legacy oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving right. - * @returns The number of characters by which the selection was moved. */ - moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + legacyObliqueTopRight = "LegacyObliqueTopRight", /** - * Moves the start position of the selection. - * + * Represents a legacy oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for the `moveStart` operation. - * @returns The number of characters by which the selection was moved. */ - moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + legacyObliqueLeft = "LegacyObliqueLeft", /** - * Moves the start position of the selection until one of the specified characters is found in the document. - * + * Represents a legacy oblique front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + legacyObliqueFront = "LegacyObliqueFront", /** - * Moves the start position of the selection while any of the specified characters are found in the document. - * + * Represents a legacy oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + legacyObliqueRight = "LegacyObliqueRight", /** - * Moves the selection until one of the specified characters is found in the document. - * + * Represents a legacy oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", /** - * Moves the selection up. - * + * Represents a legacy oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for moving up. - * @returns The number of characters by which the selection was moved. */ - moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + legacyObliqueBottom = "LegacyObliqueBottom", /** - * Moves the selection while any of the specified characters are found in the document. - * + * Represents a legacy oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. - * @param count - Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + legacyObliqueBottomRight = "LegacyObliqueBottomRight", /** - * Selects the next field. - * + * Represents a legacy perspective top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The next field. */ - nextField(): Word.Field; + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", /** - * Moves the selection to the next subDocument. - * + * Represents a legacy perspective top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSubdocument(): void; + legacyPerspectiveTop = "LegacyPerspectiveTop", /** - * Pastes the content from clipboard and formats them as specified. - * + * Represents a legacy perspective top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type - The format paste type for table cells */ - pasteAndFormat(type: Word.PasteFormatType): void; + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", /** - * Pastes the content from clipboard and formats them as specified. - * + * Represents a legacy perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type - The format paste type for table cells */ - pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + legacyPerspectiveLeft = "LegacyPerspectiveLeft", /** - * Pastes and formats a Microsoft Excel table. - * + * Represents a legacy perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param linkedToExcel - Whether the table is linked to Excel. - * @param wordFormatting - Whether to apply Word formatting. - * @param rtf - Whether to paste as Rich Text Format (RTF). */ - pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + legacyPerspectiveFront = "LegacyPerspectiveFront", /** - * Applies formatting copied with the `copyFormat` method to the selection. - * + * Represents a legacy perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteFormat(): void; + legacyPerspectiveRight = "LegacyPerspectiveRight", /** - * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. - * + * Represents a legacy perspective bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteTableCellsAppendTable(): void; + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", /** - * Pastes a cell or group of cells as a nested table into the selection. - * + * Represents a legacy perspective bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteTableCellsAsNestedTable(): void; + legacyPerspectiveBottom = "LegacyPerspectiveBottom", /** - * Selects and returns the previous field. - * + * Represents a legacy perspective bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The previous field. */ - previousField(): Word.Field; + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", /** - * Moves the selection to the previous subDocument. - * + * Represents an orthographic front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSubdocument(): void; + orthographicFront = "OrthographicFront", /** - * Replaces the selection with a new paragraph. - * + * Represents an isometric top-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replaceParagraph(): void; + isometricTopUp = "IsometricTopUp", /** - * Selects the current text. - * + * Represents an isometric top-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + isometricTopDown = "IsometricTopDown", /** - * Selects the entire cell containing the current selection when the selection is in a table. - * + * Represents an isometric bottom-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCell(): void; + isometricBottomUp = "IsometricBottomUp", /** - * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. - * + * Represents an isometric bottom-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectColumn(): void; + isometricBottomDown = "IsometricBottomDown", /** - * Extends the selection forward until text with a different paragraph alignment is encountered. - * + * Represents an isometric left-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentAlignment(): void; + isometricLeftUp = "IsometricLeftUp", /** - * Extends the selection forward until text with a different color is encountered. - * + * Represents an isometric left-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentColor(): void; + isometricLeftDown = "IsometricLeftDown", /** - * Extends the selection forward until text in a different font or font size is encountered. - * + * Represents an isometric right-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentFont(): void; + isometricRightUp = "IsometricRightUp", /** - * Extends the selection forward until text with different left or right paragraph indents is encountered. - * + * Represents an isometric right-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentIndent(): void; + isometricRightDown = "IsometricRightDown", /** - * Extends the selection forward until a paragraph with different line spacing is encountered. - * + * Represents an isometric off-axis 1 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentSpacing(): void; + isometricOffAxis1Left = "IsometricOffAxis1Left", /** - * Extends the selection forward until a paragraph with different tab stops is encountered. - * + * Represents an isometric off-axis 1 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentTabs(): void; + isometricOffAxis1Right = "IsometricOffAxis1Right", /** - * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. - * + * Represents an isometric off-axis 1 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectRow(): void; + isometricOffAxis1Top = "IsometricOffAxis1Top", /** - * Sets the starting and ending character positions for the selection. - Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. - * + * Represents an isometric off-axis 2 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param start - The starting character position of the current story. - * @param end - The ending character position of the current story. */ - setRange(start: number, end: number): void; + isometricOffAxis2Left = "IsometricOffAxis2Left", /** - * Shrinks the selection to the next smaller unit of text. - The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. - * + * Represents an isometric off-axis 2 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shrink(): void; + isometricOffAxis2Right = "IsometricOffAxis2Right", /** - * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. - * + * Represents an isometric off-axis 2 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shrinkDiscontiguousSelection(): void; + isometricOffAxis2Top = "IsometricOffAxis2Top", /** - * Inserts an empty paragraph above the first row in the selection. - If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. - * + * Represents an isometric off-axis 3 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitTable(): void; + isometricOffAxis3Left = "IsometricOffAxis3Left", /** - * Switches the selection between a Unicode character and its corresponding hexadecimal value. - * + * Represents an isometric off-axis 3 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggleCharacterCode(): void; + isometricOffAxis3Right = "IsometricOffAxis3Right", /** - * Deletes the character preceding the selection (if collapsed) or the insertion point. - * + * Represents an isometric off-axis 3 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - typeBackspace(): 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.SelectionLoadOptions): Word.Selection; - /** - * 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.Selection; - /** - * 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.Selection; - /** - * 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.Selection; - /** - * 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.Selection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.SelectionData; - } - /** - * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RangeScopedCollection 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.Range[]; + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", /** - * Gets a `Range` object by its index in the collection. - * + * Represents an isometric off-axis 4 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The location of a `Range` object in the collection. */ - getItem(index: number): Word.Range; - /** - * 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.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + isometricOffAxis4Left = "IsometricOffAxis4Left", /** - * 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. + * Represents an isometric off-axis 4 right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RangeScopedCollection; + isometricOffAxis4Right = "IsometricOffAxis4Right", /** - * 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. + * Represents an isometric off-axis 4 bottom camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeScopedCollection; + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", /** - * 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. + * Represents an oblique top-left camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RangeScopedCollection; + obliqueTopLeft = "ObliqueTopLeft", /** - * 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. + * Represents an oblique top camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RangeScopedCollection; + obliqueTop = "ObliqueTop", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Represents an oblique top-right camera type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RangeScopedCollectionData; - } - /** - * Specifies the direction in which text flows from one text column to the next. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FlowDirection { + obliqueTopRight = "ObliqueTopRight", /** - * Text flows from left to right. + * Represents an oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + obliqueLeft = "ObliqueLeft", /** - * Text flows from right to left. + * Represents an oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", - } - /** - * Specifies where the gutter appears in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterPosition { + obliqueRight = "ObliqueRight", /** - * The gutter appears on the left side of the document. + * Represents an oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + obliqueBottomLeft = "ObliqueBottomLeft", /** - * The gutter appears on the right side of the document. + * Represents an oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + obliqueBottom = "ObliqueBottom", /** - * The gutter appears at the top of the document. + * Represents an oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", - } - /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterStyle { + obliqueBottomRight = "ObliqueBottomRight", /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * Represents a perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + perspectiveFront = "PerspectiveFront", /** - * Gutter style for Latin text flow. This is mainly left to right. + * Represents a perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies how text is laid out in the layout mode for the current document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LayoutMode { + perspectiveLeft = "PerspectiveLeft", /** - * Default layout mode. + * Represents a perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + perspectiveRight = "PerspectiveRight", /** - * Grid layout mode. + * Represents a perspective above camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid = "Grid", + perspectiveAbove = "PerspectiveAbove", /** - * Line grid layout mode. + * Represents a perspective below camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineGrid = "LineGrid", + perspectiveBelow = "PerspectiveBelow", /** - * Genko layout mode. + * Represents a perspective above-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - genko = "Genko", - } - /** - * Specifies the numbering rule to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberingRule { + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", /** - * Restart numbering continuously. + * Represents a perspective above-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartContinuous = "RestartContinuous", + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", /** - * Restart numbering at the beginning of each section. + * Represents a perspective contrasting-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartSection = "RestartSection", + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", /** - * Restart numbering at the beginning of each page. + * Represents a perspective contrasting-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartPage = "RestartPage", - } - /** - * Specifies a page layout orientation. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageOrientation { + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", /** - * Portrait orientation. + * Represents a perspective heroic-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portrait = "Portrait", + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", /** - * Landscape orientation. + * Represents a perspective heroic-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - landscape = "Landscape", - } - /** - * Specifies the type of vertical alignment to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageSetupVerticalAlignment { + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", /** - * Align text to the top. + * Represents a perspective heroic-extreme left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", /** - * Align text to the center. + * Represents a perspective heroic-extreme right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", /** - * Justify text vertically. + * Represents a relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justify = "Justify", + perspectiveRelaxed = "PerspectiveRelaxed", /** - * Align text to the bottom. + * Represents a moderately relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", } /** - * Specifies a paper size. + * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PaperSize { + enum PresetExtrusionDirection { /** - * 10x14 paper size. + * Represents a mixed extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size10x14 = "Size10x14", + mixed = "Mixed", /** - * 11x17 paper size. + * Represents an extrusion direction to the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size11x17 = "Size11x17", + bottomRight = "BottomRight", /** - * Letter paper size. + * Represents an extrusion direction to the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + bottom = "Bottom", /** - * Small letter paper size. + * Represents an extrusion direction to the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterSmall = "LetterSmall", + bottomLeft = "BottomLeft", /** - * Legal paper size. + * Represents an extrusion direction to the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legal = "Legal", + right = "Right", /** - * Executive paper size. + * Represents no extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - executive = "Executive", + none = "None", /** - * A3 paper size. + * Represents an extrusion direction to the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a3 = "A3", + left = "Left", /** - * A4 paper size. + * Represents an extrusion direction to the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4 = "A4", + topRight = "TopRight", /** - * Small A4 paper size. + * Represents an extrusion direction to the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4Small = "A4Small", + top = "Top", /** - * A5 paper size. + * Represents an extrusion direction to the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a5 = "A5", + topLeft = "TopLeft", + } + /** + * Specifies which predefined gradient to use to fill a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetGradientType { /** - * B4 paper size. + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b4 = "B4", + mixed = "Mixed", /** - * B5 paper size. + * A warm gradient resembling an early sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b5 = "B5", + earlySunset = "EarlySunset", /** - * C-sheet paper size. + * A deeper, richer gradient resembling a late sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - csheet = "CSheet", + lateSunset = "LateSunset", /** - * D-sheet paper size. + * A dark gradient evoking the colors of nightfall. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dsheet = "DSheet", + nightfall = "Nightfall", /** - * E-sheet paper size. + * A light gradient representing the colors of daybreak. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - esheet = "ESheet", + daybreak = "Daybreak", /** - * Fanfold legal German paper size. + * A gradient that mimics the colors of the horizon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldLegalGerman = "FanfoldLegalGerman", + horizon = "Horizon", /** - * Fanfold standard German paper size. + * A warm, sandy gradient inspired by desert tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldStdGerman = "FanfoldStdGerman", + desert = "Desert", /** - * Fanfold US paper size. + * A cool gradient reflecting ocean hues. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldUS = "FanfoldUS", + ocean = "Ocean", /** - * Folio paper size. + * A soft, tranquil gradient resembling calm water. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - folio = "Folio", + calmWater = "CalmWater", /** - * Ledger paper size. + * A vivid gradient with fiery tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ledger = "Ledger", + fire = "Fire", /** - * Note paper size. + * A muted gradient with fog-like softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - note = "Note", + fog = "Fog", /** - * Quarto paper size. + * A natural green gradient inspired by moss. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quarto = "Quarto", + moss = "Moss", /** - * Statement paper size. + * A vibrant gradient with peacock feather colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - statement = "Statement", + peacock = "Peacock", /** - * Tabloid paper size. + * A light, golden gradient resembling wheat. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabloid = "Tabloid", + wheat = "Wheat", /** - * Envelope size 9. + * A warm, aged paper-like gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope9 = "Envelope9", + parchment = "Parchment", /** - * Envelope size 10. + * A rich, reddish-brown gradient like mahogany wood. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope10 = "Envelope10", + mahogany = "Mahogany", /** - * Envelope size 11. + * A colorful gradient resembling a rainbow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope11 = "Envelope11", + rainbow = "Rainbow", /** - * Envelope size 12. + * A variation of the rainbow gradient with different color emphasis. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope12 = "Envelope12", + rainbowII = "RainbowII", /** - * Envelope size 14. + * A shiny, metallic gold gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope14 = "Envelope14", + gold = "Gold", /** - * Envelope B4 size. + * A variation of the gold gradient with different tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB4 = "EnvelopeB4", + goldII = "GoldII", /** - * Envelope B5 size. + * A metallic gradient resembling brass. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB5 = "EnvelopeB5", + brass = "Brass", /** - * Envelope B6 size. + * A sleek, reflective chrome gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB6 = "EnvelopeB6", + chrome = "Chrome", /** - * Envelope C3 size. + * A variation of the chrome gradient with alternate highlights. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC3 = "EnvelopeC3", + chromeII = "ChromeII", /** - * Envelope C4 size. + * A smooth, metallic silver gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC4 = "EnvelopeC4", + silver = "Silver", /** - * Envelope C5 size. + * A deep blue gradient inspired by sapphire. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC5 = "EnvelopeC5", + sapphire = "Sapphire", + } + /** + * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetLightingDirection { /** - * Envelope C6 size. + * Represents a mixed lighting direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC6 = "EnvelopeC6", + mixed = "Mixed", /** - * Envelope C65 size. + * Represents lighting from the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC65 = "EnvelopeC65", + topLeft = "TopLeft", /** - * Envelope DL size. + * Represents lighting from the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeDL = "EnvelopeDL", + top = "Top", /** - * Envelope Italy size. + * Represents lighting from the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeItaly = "EnvelopeItaly", + topRight = "TopRight", /** - * Envelope Monarch size. + * Represents lighting from the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeMonarch = "EnvelopeMonarch", + left = "Left", /** - * Envelope Personal size. + * Represents no lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopePersonal = "EnvelopePersonal", + none = "None", /** - * Custom paper size. + * Represents lighting from the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies how Word displays the reading order and alignment for the specified sections. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SectionDirection { + right = "Right", /** - * Right-to-left reading order. + * Represents lighting from the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + bottomLeft = "BottomLeft", /** - * Left-to-right reading order. + * Represents lighting from the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + bottom = "Bottom", + /** + * Represents lighting from the bottom-right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRight = "BottomRight", } /** - * Specifies the type of section break for the specified item. + * Specifies the intensity of light used on a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionStart { - /** - * Continuous section break. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - continuous = "Continuous", + enum PresetLightingSoftness { /** - * New column section break. + * Represents a mixed lighting softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newColumn = "NewColumn", + mixed = "Mixed", /** - * New page section break. + * Represents dim lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newPage = "NewPage", + dim = "Dim", /** - * Even page section break. + * Represents normal lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPage = "EvenPage", + normal = "Normal", /** - * Odd page section break. + * Represents bright lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddPage = "OddPage", + bright = "Bright", } /** - * Specifies how a table is resized to fit its contents or the window. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum AutoFitBehavior { + enum PresetMaterial { /** - * Disables automatic resizing. The table retains its current size. + * Represents a mixed material type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fixedSize = "FixedSize", + mixed = "Mixed", /** - * Automatically resizes the table columns to fit the contents. + * Represents a matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - content = "Content", + matte = "Matte", /** - * Automatically resizes the table to fit the window width. + * Represents a plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - window = "Window", - } - /** - * Specifies the type of bidirectional calendar to use. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CalendarTypeBidirectional { + plastic = "Plastic", /** - * Uses the Gregorian calendar. + * Represents a metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gregorian = "Gregorian", + metal = "Metal", /** - * Uses the Bidirectional calendar. + * Represents a wireframe material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", - } - /** - * Specifies the type of caption label to use. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CaptionLabelType { + wireFrame = "WireFrame", /** - * Specifies a figure caption label. + * Represents a second matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - figure = "Figure", + matte2 = "Matte2", /** - * Specifies a table caption label. + * Represents a second plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + plastic2 = "Plastic2", /** - * Specifies an equation caption label. + * Represents a second metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equation = "Equation", - } - /** - * Specifies the position of a caption relative to the object it describes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CaptionPosition { + metal2 = "Metal2", /** - * Places the caption above the selected item. + * Represents a warm matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - above = "Above", + warmMatte = "WarmMatte", /** - * Places the caption below the selected item. + * Represents a translucent powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - below = "Below", - } - /** - * Specifies the direction in which to collapse a selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CollapseDirection { + translucentPowder = "TranslucentPowder", /** - * Collapses the selection to the start position. + * Represents a powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start = "Start", + powder = "Powder", /** - * Collapses the selection to the end position. + * Represents a dark edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end = "End", - } - /** - * Specifies the language to use for date formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DateLanguage { + darkEdge = "DarkEdge", /** - * Uses the bidirectional date/time format. + * Represents a soft edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + softEdge = "SoftEdge", /** - * Uses the latin date/time format. + * Represents a clear material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies the default behavior when inserting a new table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DefaultTableBehavior { + clear = "Clear", /** - * Disables AutoFit. + * Represents a flat material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableAutoFit = "DisableAutoFit", + flat = "Flat", /** - * Enables AutoFit. + * Represents a soft metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enableAutoFit = "EnableAutoFit", + softMetal = "SoftMetal", } /** - * Specifies the location of endnotes in a Word document. + * Specifies texture to be used to fill a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum EndnoteLocation { + enum PresetTexture { /** - * Places endnotes at the end of the section. + * Represents a mixed texture type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endOfSection = "EndOfSection", + mixed = "Mixed", /** - * Places endnotes at the end of the document. + * Represents a papyrus texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endOfDocument = "EndOfDocument", - } - /** - * Specifies the font bias to use when formatting East Asian text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FontBias { + papyrus = "Papyrus", /** - * Uses the default font bias. + * Represents a canvas texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + canvas = "Canvas", /** - * Uses the font bias for Far East text. + * Represents a denim texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast = "FarEast", + denim = "Denim", /** - * No font bias specified. + * Represents a woven mat texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpecified = "NoSpecified", - } - /** - * Specifies the location of footnotes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FootnoteLocation { + wovenMat = "WovenMat", /** - * Places footnotes at the bottom of the page. + * Represents a water droplets texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomOfPage = "BottomOfPage", + waterDroplets = "WaterDroplets", /** - * Places footnotes below the text on the page. + * Represents a paper bag texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beneathText = "BeneathText", - } - /** - * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GoToDirection { + paperBag = "PaperBag", /** - * Moves to the first item. + * Represents a fish fossil texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - first = "First", + fishFossil = "FishFossil", /** - * Moves to the last item. + * Represents a sand texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - last = "Last", + sand = "Sand", /** - * Moves to the next item. + * Represents a green marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + greenMarble = "GreenMarble", /** - * Moves to the previous item. + * Represents a white marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous = "Previous", - } - /** - * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GoToItem { + whiteMarble = "WhiteMarble", /** - * Moves to a bookmark. + * Represents a brown marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark = "Bookmark", + brownMarble = "BrownMarble", /** - * Moves to a comment. + * Represents a granite texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comment = "Comment", + granite = "Granite", /** - * Moves to a endnote. + * Represents a newsprint texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnote = "Endnote", + newsprint = "Newsprint", /** - * Moves to a field. + * Represents a recycled paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - field = "Field", + recycledPaper = "RecycledPaper", /** - * Moves to a footnote. + * Represents a parchment texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnote = "Footnote", + parchment = "Parchment", /** - * Moves to a graphic. + * Represents a stationery texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - graphic = "Graphic", + stationery = "Stationery", /** - * Moves to a heading. + * Represents a blue tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heading = "Heading", + blueTissuePaper = "BlueTissuePaper", /** - * Moves to a line. + * Represents a pink tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line = "Line", + pinkTissuePaper = "PinkTissuePaper", /** - * Moves to a page. + * Represents a purple mesh texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - page = "Page", + purpleMesh = "PurpleMesh", /** - * Moves to a section. + * Represents a bouquet texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - section = "Section", + bouquet = "Bouquet", /** - * Moves to a table. + * Represents a cork texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + cork = "Cork", /** - * Moves to an embedded object. + * Represents a walnut texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - embeddedObject = "EmbeddedObject", + walnut = "Walnut", /** - * Moves to an equation. + * Represents an oak texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equation = "Equation", + oak = "Oak", /** - * Moves to a percent. + * Represents a medium wood texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + mediumWood = "MediumWood", + } + /** + * Specifies an extrusion (three-dimensional) format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetThreeDimensionalFormat { /** - * Moves to a spelling error. + * Represents a mixed three-dimensional format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingError = "SpellingError", + mixed = "Mixed", /** - * Moves to a grammatical error. + * Represents three-dimensional format 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammaticalError = "GrammaticalError", + format1 = "Format1", /** - * Moves to a proofreading error. + * Represents three-dimensional format 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proofreadingError = "ProofreadingError", - } - /** - * Specifies the type of movement when navigating through a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum MovementType { + format2 = "Format2", /** - * Moves the insertion point or selection. + * Represents three-dimensional format 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - move = "Move", + format3 = "Format3", /** - * Extends the selection. + * Represents three-dimensional format 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend = "Extend", - } - /** - * Specifies the numbering style to use for footnotes or endnotes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NoteNumberStyle { + format4 = "Format4", /** - * Uses Arabic numerals (1, 2, 3...). + * Represents three-dimensional format 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + format5 = "Format5", /** - * Uses uppercase Roman numerals (I, II, III...). + * Represents three-dimensional format 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uppercaseRoman = "UppercaseRoman", + format6 = "Format6", /** - * Uses lowercase Roman numerals (i, ii, iii...). + * Represents three-dimensional format 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowercaseRoman = "LowercaseRoman", + format7 = "Format7", /** - * Uses uppercase letters (A, B, C...). + * Represents three-dimensional format 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uppercaseLetter = "UppercaseLetter", + format8 = "Format8", /** - * Uses lowercase letters (a, b, c...). + * Represents three-dimensional format 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowercaseLetter = "LowercaseLetter", + format9 = "Format9", /** - * Uses a symbol instead of a number. + * Represents three-dimensional format 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - symbol = "Symbol", + format10 = "Format10", /** - * Uses full-width Arabic numerals. + * Represents three-dimensional format 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicFullWidth = "ArabicFullWidth", + format11 = "Format11", /** - * Uses Kanji characters. + * Represents three-dimensional format 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanji = "Kanji", + format12 = "Format12", /** - * Uses Kanji digits. + * Represents three-dimensional format 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanjiDigit = "KanjiDigit", + format13 = "Format13", /** - * Uses traditional Kanji characters. + * Represents three-dimensional format 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanjiTraditional = "KanjiTraditional", + format14 = "Format14", /** - * Uses numbers enclosed in circles. + * Represents three-dimensional format 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberInCircle = "NumberInCircle", + format15 = "Format15", /** - * Uses Hanja characters with phonetic reading. + * Represents three-dimensional format 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hanjaRead = "HanjaRead", + format16 = "Format16", /** - * Uses Hanja digits with phonetic reading. + * Represents three-dimensional format 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hanjaReadDigit = "HanjaReadDigit", + format17 = "Format17", /** - * Uses traditional Chinese numerals (style 1). + * Represents three-dimensional format 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChineseNumeral1 = "traditionalChineseNumeral1", + format18 = "Format18", /** - * Uses traditional Chinese numerals (style 2). + * Represents three-dimensional format 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChineseNumeral2 = "traditionalChineseNumeral2", + format19 = "Format19", /** - * Uses simplified Chinese numerals (style 1). + * Represents three-dimensional format 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + format20 = "Format20", + } + /** + * Specifies the type of the {@link Word.ReflectionFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReflectionType { /** - * Uses simplified Chinese numerals (style 2). + * Represents a mixed reflection type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + mixed = "Mixed", /** - * Uses Hebrew letters (style 1). + * Represents no reflection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrewLetter1 = "HebrewLetter1", + none = "None", /** - * Uses Arabic letters (style 1). + * Represents reflection type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLetter1 = "ArabicLetter1", + type1 = "Type1", /** - * Uses Hebrew letters (style 2). + * Represents reflection type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrewLetter2 = "HebrewLetter2", + type2 = "Type2", /** - * Uses Arabic letters (style 2). + * Represents reflection type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLetter2 = "ArabicLetter2", + type3 = "Type3", /** - * Uses Hindi letters (style 1). + * Represents reflection type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiLetter1 = "HindiLetter1", + type4 = "Type4", /** - * Uses Hindi letters (style 2). + * Represents reflection type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiLetter2 = "HindiLetter2", + type5 = "Type5", /** - * Uses Hindi Arabic numerals. + * Represents reflection type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiArabic = "HindiArabic", + type6 = "Type6", /** - * Uses Hindi cardinal text. + * Represents reflection type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiCardinalText = "HindiCardinalText", + type7 = "Type7", /** - * Uses Thai letters. + * Represents reflection type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiLetter = "ThaiLetter", + type8 = "Type8", /** - * Uses Thai Arabic numerals. + * Represents reflection type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiArabic = "ThaiArabic", + type9 = "Type9", + } + /** + * Specifies the type of shadowing effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShadowStyle { /** - * Uses Thai cardinal text. + * Represents a mixed shadow style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiCardinalText = "ThaiCardinalText", + mixed = "Mixed", /** - * Uses Vietnamese cardinal text. + * Represents an outer shadow style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vietnameseCardinalText = "vietnameseCardinalText", + outerShadow = "OuterShadow", + /** + * Represents an inner shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + innerShadow = "InnerShadow", } /** - * Specifies the unit of measurement used in Word operations. + * Specifies the type of shadow displayed with a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum OperationUnit { + enum ShadowType { /** - * Specifies a character unit. + * Represents a mixed shadow type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - character = "Character", + mixed = "Mixed", /** - * Specifies a word unit. + * Represents shadow type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word = "Word", + type1 = "Type1", /** - * Specifies a sentence unit. + * Represents shadow type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sentence = "Sentence", + type2 = "Type2", /** - * Specifies a paragraph unit. + * Represents shadow type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + type3 = "Type3", /** - * Specifies a line unit. + * Represents shadow type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line = "Line", + type4 = "Type4", /** - * Specifies a story unit. + * Represents shadow type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - story = "Story", + type5 = "Type5", /** - * Specifies a screen unit. + * Represents shadow type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screen = "Screen", + type6 = "Type6", /** - * Specifies a section unit. + * Represents shadow type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - section = "Section", + type7 = "Type7", /** - * Specifies a column unit. + * Represents shadow type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - column = "Column", + type8 = "Type8", /** - * Specifies a row unit. + * Represents shadow type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + type9 = "Type9", /** - * Specifies a window unit. + * Represents shadow type 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - window = "Window", + type10 = "Type10", /** - * Specifies a cell unit. + * Represents shadow type 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cell = "Cell", + type11 = "Type11", /** - * Specifies a character format unit. + * Represents shadow type 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterFormat = "CharacterFormat", + type12 = "Type12", /** - * Specifies a paragraph format unit. + * Represents shadow type 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphFormat = "ParagraphFormat", + type13 = "Type13", /** - * Specifies a table unit. + * Represents shadow type 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + type14 = "Type14", /** - * Specifies an item unit. + * Represents shadow type 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - item = "Item", - } - /** - * Specifies the format to use when pasting data. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PasteDataType { + type15 = "Type15", /** - * Pastes the data as an OLE object. + * Represents shadow type 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oleObject = "OleObject", + type16 = "Type16", /** - * Pastes the data as rich text format (RTF). + * Represents shadow type 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rtf = "Rtf", + type17 = "Type17", /** - * Pastes the data as plain text. + * Represents shadow type 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "Text", + type18 = "Type18", /** - * Pastes the data as a metafile picture. + * Represents shadow type 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metafilePicture = "MetafilePicture", + type19 = "Type19", /** - * Pastes the data as a bitmap. + * Represents shadow type 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bitmap = "Bitmap", + type20 = "Type20", /** - * Pastes the data as a device-independent bitmap (DIB). + * Represents shadow type 21. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - deviceIndependentBitmap = "DeviceIndependentBitmap", + type21 = "Type21", /** - * Pastes the data as a hyperlink. + * Represents shadow type 22. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + type22 = "Type22", /** - * Pastes the data as a shape. + * Represents shadow type 23. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + type23 = "Type23", /** - * Pastes the data as an enhanced metafile. + * Represents shadow type 24. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enhancedMetafile = "EnhancedMetafile", + type24 = "Type24", /** - * Pastes the data as HTML. + * Represents shadow type 25. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - html = "Html", - } - /** - * Specifies the type of formatting when paste to a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PasteFormatType { + type25 = "Type25", /** - * Uses the default paste behavior. + * Represents shadow type 26. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteDefault = "PasteDefault", + type26 = "Type26", /** - * Pastes text into a single cell. + * Represents shadow type 27. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleCellText = "SingleCellText", + type27 = "Type27", /** - * Pastes a table into a single cell. + * Represents shadow type 28. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleCellTable = "SingleCellTable", + type28 = "Type28", /** - * Continues numbering from the previous list. + * Represents shadow type 29. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listContinueNumbering = "ListContinueNumbering", + type29 = "Type29", /** - * Restarts numbering for the new list. + * Represents shadow type 30. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listRestartNumbering = "ListRestartNumbering", + type30 = "Type30", /** - * Appends the pasted table to the existing table. + * Represents shadow type 31. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableAppendTable = "TableAppendTable", + type31 = "Type31", /** - * Inserts the pasted table as new rows. + * Represents shadow type 32. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableInsertAsRows = "TableInsertAsRows", + type32 = "Type32", /** - * Inserts the pasted table with its original formatting. + * Represents shadow type 33. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOriginalFormatting = "TableOriginalFormatting", + type33 = "Type33", /** - * Pastes a chart as a picture. + * Represents shadow type 34. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chartPicture = "ChartPicture", + type34 = "Type34", /** - * Pastes a chart as an editable chart. + * Represents shadow type 35. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chart = "Chart", + type35 = "Type35", /** - * Pastes a chart with a link to the source data. + * Represents shadow type 36. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chartLinked = "ChartLinked", + type36 = "Type36", /** - * Applies the original formatting of the pasted content. + * Represents shadow type 37. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatOriginalFormatting = "FormatOriginalFormatting", + type37 = "Type37", /** - * Applies surrounding formatting with emphasis. + * Represents shadow type 38. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + type38 = "Type38", /** - * Pastes content as plain text. + * Represents shadow type 39. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatPlainText = "FormatPlainText", + type39 = "Type39", /** - * Overwrites existing cells with the pasted table. + * Represents shadow type 40. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOverwriteCells = "TableOverwriteCells", + type40 = "Type40", /** - * Combines the pasted list with an existing list. + * Represents shadow type 41. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listCombineWithExistingList = "ListCombineWithExistingList", + type41 = "Type41", /** - * Prevents merging the pasted list with an existing list. + * Represents shadow type 42. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listDontMerge = "ListDontMerge", + type42 = "Type42", /** - * Uses the destination styles for the pasted content. + * Represents shadow type 43. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useDestinationStylesRecovery = "UseDestinationStylesRecovery", + type43 = "Type43", } /** - * Specifies the kind of reference to insert. + * Specifies the stylistic set to apply to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ReferenceKind { - /** - * Inserts the full text of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contentText = "ContentText", - /** - * Inserts the number of the referenced item with relative context. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberRelativeContext = "NumberRelativeContext", - /** - * Inserts only the number of the referenced item without context. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberNoContext = "NumberNoContext", - /** - * Inserts the number of the referenced item with full context. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - numberFullContext = "NumberFullContext", - /** - * Inserts the entire caption of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - entireCaption = "EntireCaption", - /** - * Inserts only the label and number of the referenced item. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - onlyLabelAndNumber = "OnlyLabelAndNumber", + enum StylisticSet { /** - * Inserts only the caption text of the referenced item. + * Default stylistic set. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onlyCaptionText = "OnlyCaptionText", + default = "Default", /** - * Inserts the footnote number of the referenced item. + * Stylistic set 01. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteNumber = "FootnoteNumber", + set01 = "Set01", /** - * Inserts the endnote number of the referenced item. + * Stylistic set 02. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteNumber = "EndnoteNumber", + set02 = "Set02", /** - * Inserts the page number of the referenced item. + * Stylistic set 03. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumber = "PageNumber", + set03 = "Set03", /** - * Inserts the position of the referenced item. + * Stylistic set 04. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position = "Position", + set04 = "Set04", /** - * Inserts the formatted footnote number of the referenced item. + * Stylistic set 05. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteNumberFormatted = "FootnoteNumberFormatted", + set05 = "Set05", /** - * Inserts the formatted endnote number of the referenced item. + * Stylistic set 06. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteNumberFormatted = "EndnoteNumberFormatted", - } - /** - * Specifies the type of reference to insert. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReferenceType { + set06 = "Set06", /** - * Refers to a numbered item in the document. + * Stylistic set 07. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberedItem = "NumberedItem", + set07 = "Set07", /** - * Refers to a heading in the document. + * Stylistic set 08. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heading = "Heading", + set08 = "Set08", /** - * Refers to a bookmark in the document. + * Stylistic set 09. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark = "Bookmark", + set09 = "Set09", /** - * Refers to a footnote in the document. + * Stylistic set 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnote = "Footnote", + set10 = "Set10", /** - * Refers to an endnote in the document. + * Stylistic set 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnote = "Endnote", - } - /** - * Specifies the type of selection in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SelectionType { + set11 = "Set11", /** - * No selection is made. + * Stylistic set 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSelection = "NoSelection", + set12 = "Set12", /** - * Represents an insertion point (IP) selection. + * Stylistic set 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertionPoint = "InsertionPoint", + set13 = "Set13", /** - * Represents a normal selection. + * Stylistic set 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + set14 = "Set14", /** - * Represents a frame selection. + * Stylistic set 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame = "Frame", + set15 = "Set15", /** - * Represents a column selection. + * Stylistic set 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - column = "Column", + set16 = "Set16", /** - * Represents a row selection. + * Stylistic set 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + set17 = "Set17", /** - * Represents a block selection. + * Stylistic set 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - block = "Block", + set18 = "Set18", /** - * Represents an inline shape selection. + * Stylistic set 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", + set19 = "Set19", /** - * Represents a shape selection. + * Stylistic set 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectionShape = "SelectionShape", + set20 = "Set20", } /** - * Specifies the type of field to sort by. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SortFieldType { + enum TextureAlignment { /** - * Sorts content alphanumerically. + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphanumeric = "Alphanumeric", + mixed = "Mixed", /** - * Sorts content numerically. + * Aligns the texture to the top-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numeric = "Numeric", + topLeft = "TopLeft", /** - * Sorts content by date. + * Aligns the texture to the top center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - date = "Date", + top = "Top", /** - * Sorts content by syllables. + * Aligns the texture to the top-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", + topRight = "TopRight", /** - * Sorts content using the Japanese JIS standard. + * Aligns the texture to the middle left side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanJis = "JapanJis", + left = "Left", /** - * Sorts content by stroke count. + * Aligns the texture to the center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stroke = "Stroke", + center = "Center", /** - * Sorts content using the Korean KS standard. + * Aligns the texture to the middle right side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - koreaKs = "KoreaKs", - } - /** - * Specifies the sort order. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SortOrder { + right = "Right", /** - * Sorts in ascending order. + * Aligns the texture to the bottom-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ascending = "Ascending", + bottomLeft = "BottomLeft", /** - * Sorts in descending order. + * Aligns the texture to the bottom center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - descending = "Descending", + bottom = "Bottom", + /** + * Aligns the texture to the bottom-right corner of the shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRight = "BottomRight", } /** - * Specifies where and what type of cells to add to an existing table. + * Specifies the texture type for the selected fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableCellInsertionLocation { - /** - * Inserts new cells to the left of the selected cells. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shiftRight = "ShiftRight", + enum TextureType { /** - * Inserts new cells above the selected cells. + * Mixed texture type. Used when multiple shapes with different texture types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftDown = "ShiftDown", + mixed = "Mixed", /** - * Inserts an entire row above the row that contains the selection. + * A predefined texture selected from the built-in texture gallery. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftRowDown = "ShiftRowDown", + preset = "Preset", /** - * Inserts an entire column to the left of the column that contains the selection. + * A custom texture defined by the user, typically from an image file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftColumnRight = "ShiftColumnRight", + userDefined = "UserDefined", } /** - * Specifies the predefined table formatting options. + * Specifies the theme colors for document themes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableFormat { + enum ThemeColorIndex { /** - * No table format is applied. + * Not a theme color. Used when the color is not part of the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + notThemeColor = "NotThemeColor", /** - * Applies the simple 1 table format. + * The first dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple1 = "Simple1", + mainDark1 = "MainDark1", /** - * Applies the simple 2 table format. + * The first light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple2 = "Simple2", + mainLight1 = "MainLight1", /** - * Applies the simple 3 table format. + * The second dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple3 = "Simple3", + mainDark2 = "MainDark2", /** - * Applies the classic 1 table format. + * The second light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic1 = "Classic1", + mainLight2 = "MainLight2", /** - * Applies the classic 2 table format. + * The first accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic2 = "Classic2", + accent1 = "Accent1", /** - * Applies the classic 3 table format. + * The second accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic3 = "Classic3", + accent2 = "Accent2", /** - * Applies the classic 4 table format. + * The third accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic4 = "Classic4", + accent3 = "Accent3", /** - * Applies the colorful 1 table format. + * The fourth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful1 = "Colorful1", + accent4 = "Accent4", /** - * Applies the colorful 2 table format. + * The fifth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful2 = "Colorful2", + accent5 = "Accent5", /** - * Applies the colorful 3 table format. + * The sixth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful3 = "Colorful3", + accent6 = "Accent6", /** - * Applies the columns 1 table format. + * The color used for hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns1 = "Columns1", + hyperlink = "Hyperlink", /** - * Applies the columns 2 table format. + * The color used for followed hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns2 = "Columns2", + hyperlinkFollowed = "HyperlinkFollowed", /** - * Applies the columns 3 table format. + * The first background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns3 = "Columns3", + background1 = "Background1", /** - * Applies the columns 4 table format. + * The first text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns4 = "Columns4", + text1 = "Text1", /** - * Applies the columns 5 table format. + * The second background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns5 = "Columns5", + background2 = "Background2", /** - * Applies the grid 1 table format. + * The second text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid1 = "Grid1", + text2 = "Text2", + } + /** + * Specifies the hyperlink type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HyperlinkType { /** - * Applies the grid 2 table format. + * Represents a hyperlink to a range in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid2 = "Grid2", + range = "Range", /** - * Applies the grid 3 table format. + * Represents a hyperlink to a shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid3 = "Grid3", + shape = "Shape", /** - * Applies the grid 4 table format. + * Represents a hyperlink to an inline shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid4 = "Grid4", + inlineShape = "InlineShape", + } + /** + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Bibliography 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; /** - * Applies the grid 5 table format. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid5 = "Grid5", + readonly sources: Word.SourceCollection; /** - * Applies the grid 6 table format. + * Specifies the name of the active style to use for the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid6 = "Grid6", + bibliographyStyle: string; /** - * Applies the grid 7 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - grid7 = "Grid7", + set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bibliography): void; /** - * Applies the grid 8 table format. + * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid8 = "Grid8", + generateUniqueTag(): OfficeExtension.ClientResult; /** - * Applies the list 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - list1 = "List1", + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; /** - * Applies the list 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - list2 = "List2", + load(propertyNames?: string | string[]): Word.Bibliography; /** - * Applies the list 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list3 = "List3", - /** - * Applies the list 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list4 = "List4", - /** - * Applies the list 5 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list5 = "List5", - /** - * Applies the list 6 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list6 = "List6", - /** - * Applies the list 7 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list7 = "List7", - /** - * Applies the list 8 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list8 = "List8", - /** - * Applies the 3D effects 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects1 = "ThreeDEffects1", - /** - * Applies the 3D effects 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects2 = "ThreeDEffects2", - /** - * Applies the 3D effects 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects3 = "ThreeDEffects3", - /** - * Applies the contemporary table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - contemporary = "Contemporary", - /** - * Applies the elegant table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - elegant = "Elegant", - /** - * Applies the professional table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - professional = "Professional", - /** - * Applies the subtle 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - subtle1 = "Subtle1", - /** - * Applies the subtle 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - subtle2 = "Subtle2", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bibliography; /** - * Applies the web 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - web1 = "Web1", + track(): Word.Bibliography; /** - * Applies the web 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - web2 = "Web2", + untrack(): Word.Bibliography; /** - * Applies the web 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. */ - web3 = "Web3", + toJSON(): Word.Interfaces.BibliographyData; } /** - * Specifies the orientation of text in a text frame or shape. + * Represents a collection of {@link Word.Source} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextOrientation { + export class SourceCollection 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.Source[]; /** - * Text is horizontal. + * Adds a new `Source` object to the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xml - A string containing the XML data for the source. + * @returns A `Source` object that was added to the collection. */ - horizontal = "Horizontal", + add(xml: string): Word.Source; /** - * Text is vertical with letters rotated 90 degrees clockwise. + * Gets a `Source` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - A number that identifies the index location of a `Source` object. */ - upward = "Upward", + getItem(index: number): Word.Source; /** - * Text is vertical with letters rotated 90 degrees counterclockwise. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - downward = "Downward", + load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; /** - * Text is vertical and reads downward from the top, right to left. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - verticalFarEast = "VerticalFarEast", + load(propertyNames?: string | string[]): Word.SourceCollection; /** - * Text is horizontal but from right to left to accommodate right-to-left languages. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - horizontalRotatedFarEast = "HorizontalRotatedFarEast", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; /** - * Text is vertical and reads downward from the top, left to right. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - vertical = "Vertical", + track(): Word.SourceCollection; + /** + * 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.SourceCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SourceCollectionData; } /** - * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. - The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * Represents an individual source, such as a book, journal article, or interview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class Bookmark extends OfficeExtension.ClientObject { + export class Source 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; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly range: Word.Range; - /** - * Specifies the ending character position of the bookmark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - end: number; - /** - * Returns `true` if the bookmark is a table column. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isColumn: boolean; - /** - * Returns `true` if the bookmark is empty. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isEmpty: boolean; - /** - * Returns the name of the `Bookmark` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly name: string; - /** - * Specifies the starting character position of the bookmark. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start: number; + readonly isCited: boolean; /** - * Returns the story type for the bookmark. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - /** - * 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.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bookmark): void; + readonly tag: string; /** - * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name - The name of the new bookmark. */ - copyTo(name: string): Word.Bookmark; + readonly xml: string; /** - * Deletes the bookmark. + * Deletes the `Source` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -43558,25 +43339,27 @@ export declare namespace Word { */ delete(): void; /** - * Selects the bookmark. + * Returns the value of a field in the bibliography `Source` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param name - The name of the field to retrieve. */ - select(): void; + getFieldByName(name: string): OfficeExtension.ClientResult; /** * 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.BookmarkLoadOptions): Word.Bookmark; + load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; /** * 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.Bookmark; + load(propertyNames?: string | string[]): Word.Source; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -43585,336 +43368,307 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Bookmark; + }): Word.Source; /** * 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.Bookmark; + track(): Word.Source; /** * 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.Bookmark; + untrack(): Word.Source; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BookmarkData; + toJSON(): Word.Interfaces.SourceData; } /** - * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * Represents the page setup settings for a Word document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class BookmarkCollection extends OfficeExtension.ClientObject { + export class PageSetup 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.Bookmark[]; /** - * Determines whether the specified bookmark exists. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name - A bookmark name than cannot include more than 40 characters or more than one word. - * @returns `true` if the bookmark exists. */ - exists(name: string): OfficeExtension.ClientResult; + lineNumbering: Word.LineNumbering; /** - * Gets a `Bookmark` object by its index in the collection. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `Bookmark` object. */ - getItem(index: number): Word.Bookmark; - /** - * 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.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + readonly textColumns: Word.TextColumnCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word prints the document as a booklet. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.BookmarkCollection; + bookFoldPrinting: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the number of pages for each booklet. * - * @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.BookmarkCollection; - /** - * 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.BookmarkCollection; - /** - * 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.BookmarkCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.BookmarkCollectionData; - } - /** - * Specifies the type of story in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum StoryType { - /** - * Main text story. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainText = "MainText", + bookFoldPrintingSheets: number; /** - * Footnotes story. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + bookFoldReversePrinting: boolean; /** - * Endnotes story. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + bottomMargin: number; /** - * Comments story. + * Specifies the number of characters per line in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + charsLine: number; /** - * Text frame story. + * Specifies whether the first page has a different header and footer. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textFrame = "TextFrame", + differentFirstPageHeaderFooter: boolean; /** - * Even pages header story. + * Specifies the distance between the footer and the bottom of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + footerDistance: number; /** - * Primary header story. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + gutter: number; /** - * Even pages footer story. + * Specifies on which side the gutter appears in a document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Primary footer story. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * First page header story. + * Specifies the distance between the header and the top of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + headerDistance: number; /** - * First page footer story. + * Specifies the layout mode for the current document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Footnote separator story. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + leftMargin: number; /** - * Footnote continuation separator story. + * Specifies the number of lines per page in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + linesPage: number; /** - * Footnote continuation notice story. + * Specifies if the inside and outside margins of facing pages are the same width. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + mirrorMargins: boolean; /** - * Endnote separator story. + * Specifies whether odd and even pages have different headers and footers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + oddAndEvenPagesHeaderFooter: boolean; /** - * Endnote continuation separator story. + * Specifies the orientation of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + orientation: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Endnote continuation notice story. + * Specifies the page height in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", - } - /** - * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the - indexes in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Index 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; + pageHeight: number; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + pageWidth: number; /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + rightMargin: number; /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Gets the number of columns for each page of the index. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly numberOfColumns: number; + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies if page numbers are aligned with the right margin in the index. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly rightAlignPageNumbers: boolean; + showGrid: boolean; /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly separateAccentedLetterHeadings: boolean; + suppressEndnotes: boolean; /** - * Specifies the sorting criteria for the index. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + topMargin: number; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + twoPagesOnOne: boolean; /** - * Gets the index type. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.IndexType | "Indent" | "Runin"; + verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; /** * 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.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Index): void; + set(properties: Word.PageSetup): void; /** - * Deletes this index. + * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + setAsTemplateDefault(): void; + /** + * Switches between portrait and landscape page orientations for a document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + togglePortrait(): 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.IndexLoadOptions): Word.Index; + load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; /** * 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.Index; + load(propertyNames?: string | string[]): Word.PageSetup; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -43923,6315 +43677,14480 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Index; + }): Word.PageSetup; /** * 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.Index; + track(): Word.PageSetup; /** * 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.Index; + untrack(): Word.PageSetup; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.IndexData; + toJSON(): Word.Interfaces.PageSetupData; } /** - * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * Represents line numbers in the left margin or to the left of each newspaper-style column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class IndexCollection extends OfficeExtension.ClientObject { + export class LineNumbering 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.Index[]; /** - * Returns an `Index` object that represents a new index added to the document. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range where you want the index to appear. The index replaces the range, if the range is not collapsed. - * @param indexAddOptions - Optional. The options for adding the index. */ - add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + countBy: number; /** - * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFormat(): OfficeExtension.ClientResult; + distanceFromText: number; /** - * Gets an `Index` object by its index in the collection. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of an `Index` object. */ - getItem(index: number): Word.Index; + isActive: boolean; /** - * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + /** + * Specifies the starting line number. * - * @param range - The range whose text is marked with an `XE` field throughout the document. - * @param markAllEntriesOptions - Optional. The options for marking all entries. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): void; + startingNumber: 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.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineNumbering): 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.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + load(options?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; /** * 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.IndexCollection; + load(propertyNames?: string | string[]): Word.LineNumbering; /** * 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.IndexCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineNumbering; /** * 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.IndexCollection; + track(): Word.LineNumbering; /** * 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.IndexCollection; + untrack(): Word.LineNumbering; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.IndexCollectionData; + toJSON(): Word.Interfaces.LineNumberingData; } /** - * Represents options for creating an index in a Word document. + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface IndexAddOptions { + export class TextColumnCollection 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.TextColumn[]; /** - * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. - See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. + * Returns a `TextColumn` object that represents a new text column added to a section or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Options for configuring the new text column. + * @returns A `TextColumn` object that represents a new text column added to the document. */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + add(options?: Word.TextColumnAddOptions): Word.TextColumn; /** - * If provided, specifies the sorting language to be used for the index being added. - See `LanguageId` for available values. The default value is the installed language of the Word application. + * Gets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + getFlowDirection(): OfficeExtension.ClientResult; /** - * If provided, specifies the number of columns for each page of the index. - Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + getHasLineBetween(): OfficeExtension.ClientResult; /** - * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * Gets whether text columns are evenly spaced. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + getIsEvenlySpaced(): OfficeExtension.ClientResult; /** - * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * Arranges text into the specified number of text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numColumns - The number of columns the text is to be arranged into. */ - separateAccentedLetterHeadings?: boolean; + setCount(numColumns: number): void; /** - * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. + * Sets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - The flow direction to set. */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + setFlowDirection(value: Word.FlowDirection): void; /** - * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. - Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. + * Sets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - The flow direction to set. */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** - * Represents options for marking all index entries in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface IndexMarkAllEntriesOptions { + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - `true` to show vertical lines between columns. */ - bold?: boolean; + setHasLineBetween(value: boolean): void; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * Sets whether text columns are evenly spaced. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - `true` to evenly space all the text columns in the document. */ - bookmarkName?: string; + setIsEvenlySpaced(value: boolean): void; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - crossReference?: string; + load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - crossReferenceAutoText?: string; + load(propertyNames?: string | string[]): Word.TextColumnCollection; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * 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.TextColumnCollection; + /** + * 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.TextColumnCollection; + /** + * 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.TextColumnCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TextColumnCollectionData; + } + /** + * Represents options for a new text column in a document or section of a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TextColumnAddOptions { + /** + * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + isEvenlySpaced?: boolean; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies the spacing between the text columns in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + spacing?: number; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies the width of the new text column in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + width?: number; } /** - * Represents options for marking an index entry in a Word document. + * Represents a single text column in a section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface IndexMarkEntryOptions { + export class TextColumn 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; /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + spaceAfter: number; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + width: number; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * 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.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextColumn): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - crossReference?: string; + load(options?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * 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.TextColumn; + /** + * 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.TextColumn; + /** + * 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.TextColumn; + /** + * 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.TextColumn; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextColumnData; + } + /** + * Specifies the case of the text in the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CharacterCase { + /** + * Specifies the next case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + next = "Next", /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. - * + * Specifies lowercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + lower = "Lower", /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. - * + * Specifies uppercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + upper = "Upper", /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. - * + * Specifies title case for each word. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + titleWord = "TitleWord", /** - * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. - * + * Specifies title case for the sentence. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading?: boolean; - } - /** - * Specifies the type of separator to use for headings. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum HeadingSeparator { + titleSentence = "TitleSentence", /** - * No separator is used for headings. + * Specifies toggle case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + toggle = "Toggle", /** - * A blank line is used as a separator for headings. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blankLine = "BlankLine", + halfWidth = "HalfWidth", /** - * A single letter is used as a separator for headings. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + fullWidth = "FullWidth", /** - * A lowercase letter is used as a separator for headings. + * Specifies Katakana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterLow = "LetterLow", + katakana = "Katakana", /** - * A full-width letter is used as a separator for headings. + * Specifies Hiragana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterFull = "LetterFull", + hiragana = "Hiragana", } /** - * Represents the position of a dropped capital letter. + * Specifies the character width of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DropPosition { - /** - * Represents that there's no dropped capital letter. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + enum CharacterWidth { /** - * Represents a normal dropped capital letter. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + half = "Half", /** - * Represents a dropped capital letter in the margin. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - margin = "Margin", + full = "Full", } /** - * Represents the type of line spacing. + * Specifies the seek view options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineSpacing { - /** - * Represents single line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - single = "Single", + enum SeekView { /** - * Represents 1.5 line spacing. + * Main document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onePt5 = "OnePt5", + mainDocument = "MainDocument", /** - * Represents double line spacing. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + primaryHeader = "PrimaryHeader", /** - * Represents at least line spacing. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + firstPageHeader = "FirstPageHeader", /** - * Represents exact line spacing. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + evenPagesHeader = "EvenPagesHeader", /** - * Represents multiple line spacing. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiple = "Multiple", - } - /** - * Represents the alignment of a tab stop. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TabAlignment { + primaryFooter = "PrimaryFooter", /** - * Represents that the tab stop is aligned to the left. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + firstPageFooter = "FirstPageFooter", /** - * Represents that the tab stop is aligned to the center. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + evenPagesFooter = "EvenPagesFooter", /** - * Represents that the tab stop is aligned to the right. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + footnotes = "Footnotes", /** - * Represents that the tab stop is aligned to the decimal point. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decimal = "Decimal", + endnotes = "Endnotes", /** - * Represents that the tab stop is aligned to the bar. + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bar = "Bar", + currentPageHeader = "CurrentPageHeader", /** - * Represents that the tab stop is aligned to the list. + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + currentPageFooter = "CurrentPageFooter", } /** - * Represents the type of tight wrap for a text box. + * Specifies the source documents to show. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextboxTightWrap { + enum ShowSourceDocuments { /** - * Represents that there's no tight wrap. + * Specifies that no source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Represents tight wrap around all lines. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - all = "All", - /** - * Represents tight wrap around the first and last lines. + * Specifies that the original source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstAndLastLines = "FirstAndLastLines", + original = "Original", /** - * Represents tight wrap around the first line only. + * Specifies that the revised source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstLineOnly = "FirstLineOnly", + revised = "Revised", /** - * Represents tight wrap around the last line only. + * Specifies that both the original and revised source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastLineOnly = "LastLineOnly", + both = "Both", } /** - * Specifies the filter type for an index. + * Specifies the special pane options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFilter { + enum SpecialPane { /** - * No filter is applied. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Aiueo filter is applied. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - aiueo = "Aiueo", + primaryHeader = "PrimaryHeader", /** - * Akasatana filter is applied. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - akasatana = "Akasatana", + firstPageHeader = "FirstPageHeader", /** - * Chosung filter is applied. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chosung = "Chosung", + evenPagesHeader = "EvenPagesHeader", /** - * Low filter is applied. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - low = "Low", + primaryFooter = "PrimaryFooter", /** - * Medium filter is applied. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + firstPageFooter = "FirstPageFooter", /** - * Full filter is applied. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the format for an index. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexFormat { + evenPagesFooter = "EvenPagesFooter", /** - * Template format. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + footnotes = "Footnotes", /** - * Classic format. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic = "Classic", + endnotes = "Endnotes", /** - * Fancy format. + * Footnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fancy = "Fancy", + footnoteContinuationNotice = "FootnoteContinuationNotice", /** - * Modern format. + * Footnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modern = "Modern", + footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** - * Bulleted format. + * Footnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulleted = "Bulleted", + footnoteSeparator = "FootnoteSeparator", /** - * Formal format. + * Endnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formal = "Formal", + endnoteContinuationNotice = "EndnoteContinuationNotice", /** - * Simple format. + * Endnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", - } - /** - * Specifies how an index is sorted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexSortBy { + endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** - * Sort by stroke. + * Endnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stroke = "Stroke", + endnoteSeparator = "EndnoteSeparator", /** - * Sort by syllable. + * Comments. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", - } - /** - * Specifies the type of index to create. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexType { + comments = "Comments", /** - * Creates an indented index. + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent = "Indent", + currentPageHeader = "CurrentPageHeader", /** - * Creates a run-in index. + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - runin = "Runin", - } - /** - * Specifies the tab leader style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TabLeader { + currentPageFooter = "CurrentPageFooter", /** - * Spaces are used as the tab leader. + * Revisions. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaces = "Spaces", + revisions = "Revisions", /** - * Dots are used as the tab leader. + * Revisions horizontal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dots = "Dots", + revisionsHoriz = "RevisionsHoriz", /** - * Dashes are used as the tab leader. + * Revisions vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashes = "Dashes", + revisionsVert = "RevisionsVert", + } + /** + * Specifies the save options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SaveConfiguration { /** - * Lines are used as the tab leader. + * Specifies not to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lines = "Lines", + doNotSaveChanges = "DoNotSaveChanges", /** - * Heavy lines are used as the tab leader. + * Specifies to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heavy = "Heavy", + saveChanges = "SaveChanges", /** - * Middle dots are used as the tab leader. + * Specifies to prompt to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - middleDot = "MiddleDot", + promptToSaveChanges = "PromptToSaveChanges", } /** - * Specifies the area of a table to which to apply special style formatting. + * Specifies the page color options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ConditionCode { + enum PageColor { /** - * Applies formatting to the first row in a table. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstRow = "FirstRow", + none = "None", /** - * Applies formatting to the last row in a table. + * Sepia. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastRow = "LastRow", + sepia = "Sepia", /** - * Applies formatting to odd-numbered rows. + * Inverse. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddRowBanding = "OddRowBanding", + inverse = "Inverse", + } + /** + * Specifies the page movement type in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageMovementType { /** - * Applies formatting to even-numbered rows. + * Vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenRowBanding = "EvenRowBanding", + vertical = "Vertical", /** - * Applies formatting to the first column in a table. + * Side to side. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingLayoutMargin { /** - * Applies formatting to the last column in a table. + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastColumn = "LastColumn", + automatic = "Automatic", /** - * Applies formatting to odd-numbered columns. + * Hides margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddColumnBanding = "OddColumnBanding", + suppress = "Suppress", /** - * Applies formatting to even-numbered columns. + * Shows margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenColumnBanding = "EvenColumnBanding", + full = "Full", + } + /** + * Specifies the margin for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonMargin { /** - * Applies formatting to the last cell in the first row. + * Left margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRightCell = "TopRightCell", + left = "Left", /** - * Applies formatting to the first cell in the first row. + * Right margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeftCell = "TopLeftCell", + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonWidthType { /** - * Applies formatting to the last cell in the table. + * Balloon width as a percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRightCell = "BottomRightCell", + percent = "Percent", /** - * Applies formatting to first cell in the last row of the table. + * Balloon width in points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeftCell = "BottomLeftCell", + points = "Points", } /** - * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * Specifies the extent of markup visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DeleteCells { - /** - * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - shiftLeft = "ShiftLeft", + enum RevisionsMarkup { /** - * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * No markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftUp = "ShiftUp", + none = "None", /** - * Delete the entire row of cells from the table. + * Simple markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entireRow = "EntireRow", + simple = "Simple", /** - * Delete the entire column of cells from the table. + * All markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entireColumn = "EntireColumn", + all = "All", } /** - * Specifies the rule for determining the height of the specified cells or rows. + * Specifies the display mode for tracked changes in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RowHeightRule { + enum RevisionsMode { /** - * The row height is adjusted to accommodate the tallest value in the row. + * Balloon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + balloon = "Balloon", /** - * The row height is set to a minimum value. + * Inline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + inline = "Inline", /** - * The row height is set to an exact value. + * Mixed. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + mixed = "Mixed", } /** - * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableDirection { + enum RevisionsView { /** - * The table is arranged with the first column in the rightmost position. + * Final view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + final = "Final", /** - * The table is arranged with the first column in the leftmost position. + * Original view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + original = "Original", } /** - * Specifies the character used to separate fields in a table. + * Specifies the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableFieldSeparator { + enum RevisionType { /** - * Uses the paragraph marker. + * No revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + none = "None", /** - * Uses the tab. + * Insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tab = "Tab", + insert = "Insert", /** - * Uses the comma. + * Delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comma = "Comma", + delete = "Delete", /** - * Uses the default list separator. + * Property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultListSeparator = "DefaultListSeparator", - } - /** - * Specifies the table format to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TableFormatType { + property = "Property", /** - * Applies no formatting to the table. + * Paragraph number revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + paragraphNumber = "ParagraphNumber", /** - * Applies the Simple1 table format. + * Display field revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple1 = "Simple1", + displayField = "DisplayField", /** - * Applies the Simple2 table format. + * Reconcile revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple2 = "Simple2", + reconcile = "Reconcile", /** - * Applies the Simple3 table format. + * Conflict revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple3 = "Simple3", + conflict = "Conflict", /** - * Applies the Classic1 table format. + * Style revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic1 = "Classic1", + style = "Style", /** - * Applies the Classic2 table format. + * Replace revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic2 = "Classic2", + replace = "Replace", /** - * Applies the Classic3 table format. + * Paragraph property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic3 = "Classic3", + paragraphProperty = "ParagraphProperty", /** - * Applies the Classic4 table format. + * Table property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic4 = "Classic4", + tableProperty = "TableProperty", /** - * Applies the Colorful1 table format. + * Section property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful1 = "Colorful1", + sectionProperty = "SectionProperty", /** - * Applies the Colorful2 table format. + * Style definition revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful2 = "Colorful2", + styleDefinition = "StyleDefinition", /** - * Applies the Colorful3 table format. + * Moved from revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful3 = "Colorful3", + movedFrom = "MovedFrom", /** - * Applies the Columns1 table format. + * Moved to revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns1 = "Columns1", + movedTo = "MovedTo", /** - * Applies the Columns2 table format. + * Cell insertion revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns2 = "Columns2", + cellInsertion = "CellInsertion", /** - * Applies the Columns3 table format. + * Cell deletion revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns3 = "Columns3", + cellDeletion = "CellDeletion", /** - * Applies the Columns4 table format. + * Cell merge revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns4 = "Columns4", + cellMerge = "CellMerge", /** - * Applies the Columns5 table format. + * Cell split revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns5 = "Columns5", + cellSplit = "CellSplit", /** - * Applies the Grid1 table format. + * Conflict insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid1 = "Grid1", + conflictInsert = "ConflictInsert", /** - * Applies the Grid2 table format. + * Conflict delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid2 = "Grid2", + conflictDelete = "ConflictDelete", + } + /** + * Specifies the column width options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColumnWidth { /** - * Applies the Grid3 table format. + * Narrow column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid3 = "Grid3", + narrow = "Narrow", /** - * Applies the Grid4 table format. + * Default column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid4 = "Grid4", + default = "Default", /** - * Applies the Grid5 table format. + * Wide column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid5 = "Grid5", + wide = "Wide", + } + /** + * Specifies the field shading options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FieldShading { /** - * Applies the Grid6 table format. + * Never shade fields. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid6 = "Grid6", + never = "Never", /** - * Applies the Grid7 table format. + * Always shade fields. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid7 = "Grid7", + always = "Always", /** - * Applies the Grid8 table format. + * Shade fields when selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid8 = "Grid8", + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HorizontalInVerticalType { /** - * Applies the List1 table format. + * No formatting is applied to the horizontal text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list1 = "List1", + none = "None", /** - * Applies the List2 table format. + * The horizontal text is sized to fit in the line of vertical text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list2 = "List2", + fitInLine = "FitInLine", /** - * Applies the List3 table format. + * The line of vertical text is sized to accommodate the horizontal text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list3 = "List3", + resizeLine = "ResizeLine", + } + /** + * Specifies the IME (Input Method Editor) mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ImeMode { /** - * Applies the List4 table format. + * Specifies no control over the IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list4 = "List4", + noControl = "NoControl", /** - * Applies the List5 table format. + * Specifies the IME mode is on. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list5 = "List5", + on = "On", /** - * Applies the List6 table format. + * Specifies the IME mode is off. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list6 = "List6", + off = "Off", /** - * Applies the List7 table format. + * Specifies the Hiragana IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list7 = "List7", + hiragana = "Hiragana", /** - * Applies the List8 table format. + * Specifies the Katakana (double-byte) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list8 = "List8", + katakana = "Katakana", /** - * Applies the 3D Effects1 table format. + * Specifies the Katakana (half-width) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects1 = "ThreeDEffects1", + katakanaHalf = "KatakanaHalf", /** - * Applies the 3D Effects2 table format. + * Specifies the full-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects2 = "ThreeDEffects2", + alphaFull = "AlphaFull", /** - * Applies the 3D Effects3 table format. + * Specifies the half-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects3 = "ThreeDEffects3", + alpha = "Alpha", /** - * Applies the Contemporary table format. + * Specifies the full-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contemporary = "Contemporary", + hangulFull = "HangulFull", /** - * Applies the Elegant table format. + * Specifies the half-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - elegant = "Elegant", + hangul = "Hangul", + } + /** + * Specifies the Kana type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Kana { /** - * Applies the Professional table format. + * Katakana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - professional = "Professional", + katakana = "Katakana", /** - * Applies the Subtle1 table format. + * Hiragana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle1 = "Subtle1", + hiragana = "Hiragana", + } + /** + * Specifies the two lines in one type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TwoLinesInOneType { /** - * Applies the Subtle2 table format. + * No two lines in one. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle2 = "Subtle2", + none = "None", /** - * Applies the Web1 table format. + * Two lines in one without brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web1 = "Web1", + noBrackets = "NoBrackets", /** - * Applies the Web2 table format. + * Two lines in one with parentheses. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web2 = "Web2", + parentheses = "Parentheses", /** - * Applies the Web3 table format. + * Two lines in one with square brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web3 = "Web3", + squareBrackets = "SquareBrackets", + /** + * Two lines in one with angle brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + angleBrackets = "AngleBrackets", + /** + * Two lines in one with curly brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + curlyBrackets = "CurlyBrackets", } /** - * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * Specifies the underline type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableAutoFormatOptions { + enum Underline { /** - * If provided, specifies whether to apply borders of the specified format. The default value is `true`. - * + * No underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyBorders?: boolean; + none = "None", /** - * If provided, specifies whether to apply color of the specified format. The default value is `true`. - * + * Single underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyColor?: boolean; + single = "Single", /** - * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. - * + * Underline words only. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFirstColumn?: boolean; + words = "Words", /** - * If provided, specifies whether to apply font of the specified format. The default value is `true`. - * + * Double underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFont?: boolean; + double = "Double", /** - * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. - * + * Dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyHeadingRows?: boolean; + dotted = "Dotted", /** - * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. - * + * Thick underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastColumn?: boolean; + thick = "Thick", /** - * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. - * + * Dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastRow?: boolean; + dash = "Dash", /** - * If provided, specifies whether to apply shading of the specified format. The default value is `true`. - * + * Dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyShading?: boolean; + dotDash = "DotDash", /** - * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. - * + * Dot dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit?: boolean; + dotDotDash = "DotDotDash", /** - * If provided, specifies the format to apply. The default value is `simple1`. - * + * Wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; - } - /** - * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TableCellCollectionSplitOptions { + wavy = "Wavy", /** - * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. - * + * Heavy wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mergeBeforeSplit?: boolean; + wavyHeavy = "WavyHeavy", /** - * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. - * + * Heavy dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numColumns?: number; + dottedHeavy = "DottedHeavy", /** - * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. - * + * Heavy dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numRows?: number; + dashHeavy = "DashHeavy", + /** + * Heavy dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDashHeavy = "DotDashHeavy", + /** + * Heavy dot dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dotDotDashHeavy = "DotDotDashHeavy", + /** + * Long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashLong = "DashLong", + /** + * Heavy long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashLongHeavy = "DashLongHeavy", + /** + * Double wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wavyDouble = "WavyDouble", } /** - * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * Specifies the view type in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableCellFormulaOptions { + enum ViewType { /** - * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. - * + * Normal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formula?: string; + normal = "Normal", /** - * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. - * + * Outline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numFormat?: string; + outline = "Outline", + /** + * Print. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + print = "Print", + /** + * Print preview. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + printPreview = "PrintPreview", + /** + * Master. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + master = "Master", + /** + * Web. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web = "Web", + /** + * Reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reading = "Reading", + /** + * Conflict. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + conflict = "Conflict", } /** - * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * Represents the state of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableConvertToTextOptions { + enum WindowState { /** - * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. - * + * Represents the normal state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestedTables?: boolean; + normal = "Normal", /** - * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. - * + * Represents the maximized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + maximize = "Maximize", + /** + * Represents the minimized state of the window. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + minimize = "Minimize", } /** - * Represents the options for the {@link Word.Table | Table.sort} method. + * Specifies the type of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableSortOptions { + enum WindowType { /** - * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. - * + * Specifies a document window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectionalSort?: boolean; + document = "Document", /** - * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * Specifies a template window. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + } + /** + * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionConvertToTableOptions { + /** + * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caseSensitive?: boolean; + applyBorders?: boolean; /** - * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - excludeHeader?: boolean; + applyColor?: boolean; /** - * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber?: string; + applyFirstColumn?: boolean; /** - * If provided, specifies the second field to sort by. + * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber2?: string; + applyFont?: boolean; /** - * If provided, specifies the third field to sort by. + * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber3?: string; + applyHeadingRows?: boolean; /** - * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreArabicThe?: boolean; + applyLastColumn?: boolean; /** - * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreDiacritics?: boolean; + applyLastRow?: boolean; /** - * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreHebrew?: boolean; + applyShading?: boolean; /** - * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreKashida?: boolean; + autoFit?: boolean; /** - * If provided, specifies the sorting language. + * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; /** - * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; /** - * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; /** - * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + initialColumnWidth?: number; /** - * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + numColumns?: number; /** - * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + numRows?: number; /** - * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * If provided, specifies the character used to separate text into cells. The default value is `-`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + separator?: string; } /** - * Represents a list of the names of all the available fonts. + * Represents the options for the {@link Word.Selection | Selection.delete} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class FontNameCollection 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; + export interface SelectionDeleteOptions { /** - * Returns the number of items in the collection. + * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getCount(): OfficeExtension.ClientResult; + count?: number; /** - * Gets the font name at the specified index. + * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The zero-based index of the font name to retrieve. - */ - getItemAt(index: number): OfficeExtension.ClientResult; - /** - * 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.FontNameCollection; - /** - * 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.FontNameCollection; - /** - * 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.FontNameCollection; - /** - * 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.FontNameCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): { - [key: string]: string; - }; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * Represents the options for the {@link Word.Selection | Selection.goTo} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class ListTemplateCollection 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.ListTemplate[]; + export interface SelectionGoToOptions { /** - * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for adding a new list template. */ - add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + count?: number; /** - * Gets a `ListTemplate` object by its index in the collection. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `ListTemplate` object. - */ - getItem(index: number): Word.ListTemplate; - /** - * 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.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListTemplateCollection; + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. * - * @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.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListTemplateCollectionData; + name?: string; } /** - * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface ListTemplateCollectionAddOptions { + export interface SelectionInsertCrossReferenceOptions { /** - * If provided, specifies the name of the list template to be added. + * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + includePosition?: boolean; /** - * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineNumbered?: boolean; - } - /** - * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ListTemplateGallery 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; + insertAsHyperlink?: boolean; /** - * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplates: Word.ListTemplateCollection; - /** - * 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.ListTemplateGallery; + separateNumbers?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". * - * @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.ListTemplateGallery; - /** - * 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.ListTemplateGallery; - /** - * 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.ListTemplateGallery; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListTemplateGalleryData; + separatorString?: string; } /** - * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class ListTemplateGalleryCollection 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.ListTemplateGallery[]; + export interface SelectionInsertDateTimeOptions { /** - * Gets a `ListTemplateGallery` object by its type in the collection. + * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type - The type of list template gallery to retrieve. */ - getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; /** - * Gets a `ListTemplateGallery` object by its type in the collection. + * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type - The type of list template gallery to retrieve. */ - getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; /** - * Gets a `ListTemplateGallery` object by its index in the collection. + * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `ListTemplateGallery` object. */ - getItem(index: number): Word.ListTemplateGallery; + dateTimeFormat?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListTemplateGalleryCollection; + insertAsField?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * - * @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.ListTemplateGalleryCollection; - /** - * 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.ListTemplateGalleryCollection; - /** - * 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.ListTemplateGalleryCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + insertAsFullWidth?: boolean; } /** - * Describes the types of list template galleries available. + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ListTemplateGalleryType { - /** - * Represents the bullet list gallery. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bullets = "Bullets", + export interface SelectionInsertFormulaOptions { /** - * Represents the number list gallery. + * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. + The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. + + - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. + + - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - number = "Number", + formula?: string; /** - * Represents the outline number list gallery. + * If provided, specifies the format for the result of the `= (Formula)` field. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineNumbered = "OutlineNumbered", + numberFormat?: string; } /** - * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CoauthoringLockType { - /** - * Reserved for future use. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + export interface SelectionInsertSymbolOptions { /** - * Represents that the lock is a reservation. + * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reservation = "Reservation", + bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; /** - * Represents that the lock is ephemeral. + * If provided, specifies the name of the font that contains the symbol. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ephemeral = "Ephemeral", + font?: string; /** - * Represents that the lock has changed. + * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changed = "Changed", + unicode?: boolean; } /** - * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum EditorType { + export interface SelectionMoveLeftRightOptions { /** - * Represents the current user of the document. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - current = "Current", + count?: number; /** - * Represents the Editors group for documents that use Information Rights Management. + * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - editors = "Editors", + extend?: Word.MovementType | "Move" | "Extend"; /** - * Represents all users who open a document. + * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - everyone = "Everyone", - /** - * Represents the Owners group for documents that use Information Rights Management. - * @remarks + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.move} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionMoveOptions { + /** + * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. + * + * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owners = "Owners", + count?: number; + /** + * If provided, specifies the unit by which to move the ending character position. The default value is `character`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + /** + * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionMoveStartEndOptions { + /** + * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + count?: number; + /** + * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } - export namespace Interfaces { + /** + * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionMoveUpDownOptions { /** - * Provides ways to load properties of only a subset of members of a collection. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface CollectionLoadOptions { + count?: number; + /** + * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extend?: Word.MovementType | "Move" | "Extend"; + /** + * If provided, specifies the unit by which to move the selection. The default value is `line`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.next} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionNextOptions { + /** + * If provided, specifies the number of units by which you want to move ahead. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + count?: number; + /** + * If provided, specifies the type of units by which to move the selection. The default value is `character`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.previous} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionPreviousOptions { + /** + * If provided, specifies the number of units by which you want to move. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + count?: number; + /** + * If provided, specifies the type of unit by which to move the selection. The default value is `character`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Selection 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `RangeScopedCollection` object that represents each character in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly characters: Word.RangeScopedCollection; + /** + * Returns a `CommentCollection` object that represents all the comments in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly comments: Word.CommentCollection; + /** + * Returns a `FieldCollection` object that represents all the fields in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fields: Word.FieldCollection; + /** + * Returns the `Font` object that represents the character formatting of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly font: Word.Font; + /** + * Specifies a `Range` object that includes the formatted text in the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formattedText: Word.Range; + /** + * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly paragraphs: Word.ParagraphCollection; + /** + * Returns the `Range` object for the portion of the document contained in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Returns the `SectionCollection` object in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sections: Word.SectionCollection; + /** + * Returns the `RangeScopedCollection` object for each sentence in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sentences: Word.RangeScopedCollection; + /** + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; + /** + * Returns the `TableCollection` object in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tables: Word.TableCollection; + /** + * Returns the tables at the outermost nesting level in the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly topLevelTables: Word.TableCollection; + /** + * Returns the `RangeScopedCollection` object that represents each word in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly words: Word.RangeScopedCollection; + /** + * Specifies the ending character position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Specifies the width in which Word fits the text in the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fitTextWidth: number; + /** + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly hasNoProofing: boolean; + /** + * Returns whether the selection in the specified window or pane is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isActive: boolean; + /** + * Specifies whether column selection mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isColumnSelectModeActive: boolean; + /** + * Returns whether the selection is at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEndOfRowMark: boolean; + /** + * Specifies whether Extend mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isExtendModeActive: boolean; + /** + * Returns whether the insertion point is at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isInsertionPointAtEndOfLine: boolean; + /** + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isStartActive: boolean; + /** + * Specifies whether Word has detected the language of the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected: boolean; + /** + * Returns the language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the East Asian language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the language for the selection that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyLength: number; + /** + * Returns the story type for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text: string; + /** + * Returns the selection type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + /** + * Calculates the first mathematical expression within the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The result of the calculation. + */ + calculate(): OfficeExtension.ClientResult; + /** + * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cancelMode(): void; + /** + * Removes character formatting applied through character styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearCharacterStyleFormatting(): void; + /** + * Removes character and paragraph formatting from the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearFormatting(): void; + /** + * Removes manually applied character formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualCharacterFormatting(): void; + /** + * Removes manually applied paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualParagraphFormatting(): void; + /** + * Removes all paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphFormatting(): void; + /** + * Removes paragraph formatting applied through paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphStyle(): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction - Optional. Direction to collapse. + */ + collapse(direction?: Word.CollapseDirection): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction - Optional. Direction to collapse. + */ + collapse(direction?: "Start" | "End"): void; + /** + * Converts text within a range to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for converting text to a table. + * @returns A `Table` object that represents the newly created table. + */ + convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + /** + * Copies the selection to the Clipboard as a picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyAsPictureToClipboard(): void; + /** + * Copies the character formatting of the first character in the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyFormat(): void; + /** + * Copies the selection to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyToClipboard(): void; + /** + * Adds a default-sized text box around the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + createTextBox(): void; + /** + * Removes the selected content from the document and moves it to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; + /** + * Deletes the specified number of characters or words. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for deleting text. + * @returns The number of characters deleted. + */ + delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + /** + * Analyzes the selected text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): void; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit - Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit - Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + /** + * Expands the selection to include the entire story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + expandToWholeStory(): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: Word.OperationUnit): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + /** + * Returns a `Range` object that represents the next unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `next` operation. + * @returns A `Range` object that represents the next unit relative to the selection. + */ + getNextRange(options?: Word.SelectionNextOptions): Word.Range; + /** + * Returns a `Range` object that represents the previous unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `previous` operation. + * @returns A `Range` object that represents the previous unit relative to the selection. + */ + getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + /** + * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `goTo` operation. + * @returns A `Range` object that is now selected. + */ + goTo(options?: Word.SelectionGoToOptions): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Inserts the specified text at the end of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Text to insert. + */ + insertAfter(text: string): void; + /** + * Inserts the specified text before the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Text to insert. + */ + insertBefore(text: string): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + /** + * Inserts columns to the left of the column that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsLeft(): void; + /** + * Inserts columns to the right of the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsRight(): void; + /** + * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Options for inserting the date or time. + */ + insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for inserting the formula. + */ + insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + /** + * Inserts a new page at the position of the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertNewPage(): void; + /** + * Inserts a paragraph mark after the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphAfter(): void; + /** + * Inserts a new paragraph before the selection or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphBefore(): void; + /** + * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphStyleSeparator(): void; + /** + * Inserts rows above the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows - Optional. Number of rows to insert. + */ + insertRowsAbove(numRows: number): void; + /** + * Inserts rows below the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows - Optional. Number of rows to insert. + */ + insertRowsBelow(numRows: number): void; + /** + * Inserts a symbol in place of the specified selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characterNumber - The character number of the symbol. + * @param options - Optional. Options for inserting the symbol. + */ + insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + /** + * Inserts the specified text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Text - The text to insert. + */ + insertText(Text: string): void; + /** + * Inserts the specified XML into the document at the cursor, replacing any selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xml - The XML string to insert. + * @param transform - Optional. XSL transform to apply. + */ + insertXML(xml: string, transform?: string): void; + /** + * Returns whether the selection is equal to the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is equal to the specified range. + */ + isEqual(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns `true` if the selection is contained within the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is contained within the specified range. + */ + isInRange(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns whether the selection is in the same story as the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is in the same story as the specified range. + */ + isInStory(range: Word.Range): OfficeExtension.ClientResult; + /** + * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving the selection. + * @returns The number of characters by which the selection was moved. + */ + move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + /** + * Moves the selection down. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving down. + * @returns The number of characters by which the selection was moved. + */ + moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving end. + * @returns The number of characters by which the selection was moved. + */ + moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the end position of the selection until any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving left. + * @returns The number of characters by which the selection was moved. + */ + moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the selection to the right. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving right. + * @returns The number of characters by which the selection was moved. + */ + moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `moveStart` operation. + * @returns The number of characters by which the selection was moved. + */ + moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection up. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving up. + * @returns The number of characters by which the selection was moved. + */ + moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Selects the next field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The next field. + */ + nextField(): Word.Field; + /** + * Moves the selection to the next subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSubdocument(): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The format paste type for table cells + */ + pasteAndFormat(type: Word.PasteFormatType): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The format paste type for table cells + */ + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + /** + * Pastes and formats a Microsoft Excel table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param linkedToExcel - Whether the table is linked to Excel. + * @param wordFormatting - Whether to apply Word formatting. + * @param rtf - Whether to paste as Rich Text Format (RTF). + */ + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + /** + * Applies formatting copied with the `copyFormat` method to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteFormat(): void; + /** + * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAppendTable(): void; + /** + * Pastes a cell or group of cells as a nested table into the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAsNestedTable(): void; + /** + * Selects and returns the previous field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The previous field. + */ + previousField(): Word.Field; + /** + * Moves the selection to the previous subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSubdocument(): void; + /** + * Replaces the selection with a new paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replaceParagraph(): void; + /** + * Selects the current text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Selects the entire cell containing the current selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCell(): void; + /** + * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectColumn(): void; + /** + * Extends the selection forward until text with a different paragraph alignment is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentAlignment(): void; + /** + * Extends the selection forward until text with a different color is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentColor(): void; + /** + * Extends the selection forward until text in a different font or font size is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentFont(): void; + /** + * Extends the selection forward until text with different left or right paragraph indents is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentIndent(): void; + /** + * Extends the selection forward until a paragraph with different line spacing is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentSpacing(): void; + /** + * Extends the selection forward until a paragraph with different tab stops is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentTabs(): void; + /** + * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectRow(): void; + /** + * Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param start - The starting character position of the current story. + * @param end - The ending character position of the current story. + */ + setRange(start: number, end: number): void; + /** + * Shrinks the selection to the next smaller unit of text. + The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrink(): void; + /** + * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrinkDiscontiguousSelection(): void; + /** + * Inserts an empty paragraph above the first row in the selection. + If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitTable(): void; + /** + * Switches the selection between a Unicode character and its corresponding hexadecimal value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleCharacterCode(): void; + /** + * Deletes the character preceding the selection (if collapsed) or the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + typeBackspace(): 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.SelectionLoadOptions): Word.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SelectionData; + } + /** + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class RangeScopedCollection 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.Range[]; + /** + * Gets a `Range` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `Range` object in the collection. + */ + getItem(index: number): Word.Range; + /** + * 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.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RangeScopedCollectionData; + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddPage = "OddPage", + } + /** + * Specifies how a table is resized to fit its contents or the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoFitBehavior { + /** + * Disables automatic resizing. The table retains its current size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fixedSize = "FixedSize", + /** + * Automatically resizes the table columns to fit the contents. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + content = "Content", + /** + * Automatically resizes the table to fit the window width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + } + /** + * Specifies the type of bidirectional calendar to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarTypeBidirectional { + /** + * Uses the Gregorian calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gregorian = "Gregorian", + /** + * Uses the Bidirectional calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + } + /** + * Specifies the type of caption label to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionLabelType { + /** + * Specifies a figure caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + figure = "Figure", + /** + * Specifies a table caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an equation caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + } + /** + * Specifies the position of a caption relative to the object it describes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionPosition { + /** + * Places the caption above the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + above = "Above", + /** + * Places the caption below the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + below = "Below", + } + /** + * Specifies the direction in which to collapse a selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CollapseDirection { + /** + * Collapses the selection to the start position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start = "Start", + /** + * Collapses the selection to the end position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end = "End", + } + /** + * Specifies the language to use for date formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DateLanguage { + /** + * Uses the bidirectional date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Uses the latin date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies the default behavior when inserting a new table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultTableBehavior { + /** + * Disables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableAutoFit = "DisableAutoFit", + /** + * Enables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enableAutoFit = "EnableAutoFit", + } + /** + * Specifies the location of endnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EndnoteLocation { + /** + * Places endnotes at the end of the section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfSection = "EndOfSection", + /** + * Places endnotes at the end of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfDocument = "EndOfDocument", + } + /** + * Specifies the font bias to use when formatting East Asian text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FontBias { + /** + * Uses the default font bias. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standard = "Standard", + /** + * Uses the font bias for Far East text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEast = "FarEast", + /** + * No font bias specified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpecified = "NoSpecified", + } + /** + * Specifies the location of footnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FootnoteLocation { + /** + * Places footnotes at the bottom of the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomOfPage = "BottomOfPage", + /** + * Places footnotes below the text on the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beneathText = "BeneathText", + } + /** + * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToDirection { + /** + * Moves to the first item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + first = "First", + /** + * Moves to the last item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + last = "Last", + /** + * Moves to the next item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next = "Next", + /** + * Moves to the previous item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous = "Previous", + } + /** + * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToItem { + /** + * Moves to a bookmark. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Moves to a comment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comment = "Comment", + /** + * Moves to a endnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + /** + * Moves to a field. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + field = "Field", + /** + * Moves to a footnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Moves to a graphic. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + graphic = "Graphic", + /** + * Moves to a heading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Moves to a line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Moves to a page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Moves to a section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Moves to a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Moves to an embedded object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + embeddedObject = "EmbeddedObject", + /** + * Moves to an equation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + /** + * Moves to a percent. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent = "Percent", + /** + * Moves to a spelling error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingError = "SpellingError", + /** + * Moves to a grammatical error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammaticalError = "GrammaticalError", + /** + * Moves to a proofreading error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + proofreadingError = "ProofreadingError", + } + /** + * Specifies the type of movement when navigating through a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MovementType { + /** + * Moves the insertion point or selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + move = "Move", + /** + * Extends the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extend = "Extend", + } + /** + * Specifies the numbering style to use for footnotes or endnotes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NoteNumberStyle { + /** + * Uses Arabic numerals (1, 2, 3...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabic = "Arabic", + /** + * Uses uppercase Roman numerals (I, II, III...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseRoman = "UppercaseRoman", + /** + * Uses lowercase Roman numerals (i, ii, iii...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseRoman = "LowercaseRoman", + /** + * Uses uppercase letters (A, B, C...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseLetter = "UppercaseLetter", + /** + * Uses lowercase letters (a, b, c...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseLetter = "LowercaseLetter", + /** + * Uses a symbol instead of a number. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + symbol = "Symbol", + /** + * Uses full-width Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicFullWidth = "ArabicFullWidth", + /** + * Uses Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanji = "Kanji", + /** + * Uses Kanji digits. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiDigit = "KanjiDigit", + /** + * Uses traditional Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiTraditional = "KanjiTraditional", + /** + * Uses numbers enclosed in circles. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberInCircle = "NumberInCircle", + /** + * Uses Hanja characters with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaRead = "HanjaRead", + /** + * Uses Hanja digits with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaReadDigit = "HanjaReadDigit", + /** + * Uses traditional Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral1 = "traditionalChineseNumeral1", + /** + * Uses traditional Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral2 = "traditionalChineseNumeral2", + /** + * Uses simplified Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + /** + * Uses simplified Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + /** + * Uses Hebrew letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter1 = "HebrewLetter1", + /** + * Uses Arabic letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter1 = "ArabicLetter1", + /** + * Uses Hebrew letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter2 = "HebrewLetter2", + /** + * Uses Arabic letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter2 = "ArabicLetter2", + /** + * Uses Hindi letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter1 = "HindiLetter1", + /** + * Uses Hindi letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter2 = "HindiLetter2", + /** + * Uses Hindi Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiArabic = "HindiArabic", + /** + * Uses Hindi cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiCardinalText = "HindiCardinalText", + /** + * Uses Thai letters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiLetter = "ThaiLetter", + /** + * Uses Thai Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiArabic = "ThaiArabic", + /** + * Uses Thai cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiCardinalText = "ThaiCardinalText", + /** + * Uses Vietnamese cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vietnameseCardinalText = "vietnameseCardinalText", + } + /** + * Specifies the unit of measurement used in Word operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OperationUnit { + /** + * Specifies a character unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Specifies a word unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + word = "Word", + /** + * Specifies a sentence unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sentence = "Sentence", + /** + * Specifies a paragraph unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Specifies a line unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Specifies a story unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + story = "Story", + /** + * Specifies a screen unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screen = "Screen", + /** + * Specifies a section unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Specifies a column unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Specifies a row unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Specifies a window unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + /** + * Specifies a cell unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cell = "Cell", + /** + * Specifies a character format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterFormat = "CharacterFormat", + /** + * Specifies a paragraph format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraphFormat = "ParagraphFormat", + /** + * Specifies a table unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an item unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + item = "Item", + } + /** + * Specifies the format to use when pasting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteDataType { + /** + * Pastes the data as an OLE object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oleObject = "OleObject", + /** + * Pastes the data as rich text format (RTF). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rtf = "Rtf", + /** + * Pastes the data as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text = "Text", + /** + * Pastes the data as a metafile picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metafilePicture = "MetafilePicture", + /** + * Pastes the data as a bitmap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bitmap = "Bitmap", + /** + * Pastes the data as a device-independent bitmap (DIB). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + deviceIndependentBitmap = "DeviceIndependentBitmap", + /** + * Pastes the data as a hyperlink. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlink = "Hyperlink", + /** + * Pastes the data as a shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", + /** + * Pastes the data as an enhanced metafile. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enhancedMetafile = "EnhancedMetafile", + /** + * Pastes the data as HTML. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + html = "Html", + } + /** + * Specifies the type of formatting when paste to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteFormatType { + /** + * Uses the default paste behavior. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteDefault = "PasteDefault", + /** + * Pastes text into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellText = "SingleCellText", + /** + * Pastes a table into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellTable = "SingleCellTable", + /** + * Continues numbering from the previous list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listContinueNumbering = "ListContinueNumbering", + /** + * Restarts numbering for the new list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listRestartNumbering = "ListRestartNumbering", + /** + * Appends the pasted table to the existing table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableAppendTable = "TableAppendTable", + /** + * Inserts the pasted table as new rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableInsertAsRows = "TableInsertAsRows", + /** + * Inserts the pasted table with its original formatting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOriginalFormatting = "TableOriginalFormatting", + /** + * Pastes a chart as a picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartPicture = "ChartPicture", + /** + * Pastes a chart as an editable chart. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chart = "Chart", + /** + * Pastes a chart with a link to the source data. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartLinked = "ChartLinked", + /** + * Applies the original formatting of the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatOriginalFormatting = "FormatOriginalFormatting", + /** + * Applies surrounding formatting with emphasis. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + /** + * Pastes content as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatPlainText = "FormatPlainText", + /** + * Overwrites existing cells with the pasted table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOverwriteCells = "TableOverwriteCells", + /** + * Combines the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listCombineWithExistingList = "ListCombineWithExistingList", + /** + * Prevents merging the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listDontMerge = "ListDontMerge", + /** + * Uses the destination styles for the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useDestinationStylesRecovery = "UseDestinationStylesRecovery", + } + /** + * Specifies the kind of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceKind { + /** + * Inserts the full text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contentText = "ContentText", + /** + * Inserts the number of the referenced item with relative context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberRelativeContext = "NumberRelativeContext", + /** + * Inserts only the number of the referenced item without context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberNoContext = "NumberNoContext", + /** + * Inserts the number of the referenced item with full context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFullContext = "NumberFullContext", + /** + * Inserts the entire caption of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireCaption = "EntireCaption", + /** + * Inserts only the label and number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyLabelAndNumber = "OnlyLabelAndNumber", + /** + * Inserts only the caption text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyCaptionText = "OnlyCaptionText", + /** + * Inserts the footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumber = "FootnoteNumber", + /** + * Inserts the endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumber = "EndnoteNumber", + /** + * Inserts the page number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageNumber = "PageNumber", + /** + * Inserts the position of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position = "Position", + /** + * Inserts the formatted footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumberFormatted = "FootnoteNumberFormatted", + /** + * Inserts the formatted endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumberFormatted = "EndnoteNumberFormatted", + } + /** + * Specifies the type of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceType { + /** + * Refers to a numbered item in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberedItem = "NumberedItem", + /** + * Refers to a heading in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Refers to a bookmark in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Refers to a footnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Refers to an endnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + } + /** + * Specifies the type of selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SelectionType { + /** + * No selection is made. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSelection = "NoSelection", + /** + * Represents an insertion point (IP) selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertionPoint = "InsertionPoint", + /** + * Represents a normal selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a frame selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame = "Frame", + /** + * Represents a column selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Represents a row selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Represents a block selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + block = "Block", + /** + * Represents an inline shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + inlineShape = "InlineShape", + /** + * Represents a shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectionShape = "SelectionShape", + } + /** + * Specifies the type of field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortFieldType { + /** + * Sorts content alphanumerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alphanumeric = "Alphanumeric", + /** + * Sorts content numerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numeric = "Numeric", + /** + * Sorts content by date. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date = "Date", + /** + * Sorts content by syllables. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + /** + * Sorts content using the Japanese JIS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + japanJis = "JapanJis", + /** + * Sorts content by stroke count. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sorts content using the Korean KS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + koreaKs = "KoreaKs", + } + /** + * Specifies the sort order. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortOrder { + /** + * Sorts in ascending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ascending = "Ascending", + /** + * Sorts in descending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + descending = "Descending", + } + /** + * Specifies where and what type of cells to add to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableCellInsertionLocation { + /** + * Inserts new cells to the left of the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRight = "ShiftRight", + /** + * Inserts new cells above the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftDown = "ShiftDown", + /** + * Inserts an entire row above the row that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRowDown = "ShiftRowDown", + /** + * Inserts an entire column to the left of the column that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftColumnRight = "ShiftColumnRight", + } + /** + * Specifies the predefined table formatting options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormat { + /** + * No table format is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the simple 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the simple 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the simple 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the classic 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the classic 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the classic 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the classic 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the colorful 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the colorful 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the colorful 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the columns 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the columns 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the columns 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the columns 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the columns 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the grid 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the grid 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the grid 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the grid 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the grid 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the grid 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the grid 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the grid 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the list 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the list 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the list 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the list 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the list 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the list 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the list 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the list 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D effects 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D effects 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D effects 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the subtle 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the subtle 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the web 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the web 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the web 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Specifies the orientation of text in a text frame or shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextOrientation { + /** + * Text is horizontal. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontal = "Horizontal", + /** + * Text is vertical with letters rotated 90 degrees clockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upward = "Upward", + /** + * Text is vertical with letters rotated 90 degrees counterclockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + downward = "Downward", + /** + * Text is vertical and reads downward from the top, right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalFarEast = "VerticalFarEast", + /** + * Text is horizontal but from right to left to accommodate right-to-left languages. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalRotatedFarEast = "HorizontalRotatedFarEast", + /** + * Text is vertical and reads downward from the top, left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vertical = "Vertical", + } + /** + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Bookmark 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; + /** + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * 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.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bookmark): void; + /** + * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): 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.BookmarkLoadOptions): Word.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BookmarkData; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class BookmarkCollection 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.Bookmark[]; + /** + * Determines whether the specified bookmark exists. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - A bookmark name than cannot include more than 40 characters or more than one word. + * @returns `true` if the bookmark exists. + */ + exists(name: string): OfficeExtension.ClientResult; + /** + * Gets a `Bookmark` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `Bookmark` object. + */ + getItem(index: number): Word.Bookmark; + /** + * 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.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BookmarkCollectionData; + } + /** + * Specifies the type of story in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Index 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; + /** + * Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + /** + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly rightAlignPageNumbers: boolean; + /** + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.IndexType | "Indent" | "Runin"; + /** + * 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.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Index): void; + /** + * Deletes this index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): 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.IndexLoadOptions): Word.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.IndexData; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class IndexCollection 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.Index[]; + /** + * Returns an `Index` object that represents a new index added to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range where you want the index to appear. The index replaces the range, if the range is not collapsed. + * @param indexAddOptions - Optional. The options for adding the index. + */ + add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + /** + * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Gets an `Index` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of an `Index` object. + */ + getItem(index: number): Word.Index; + /** + * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range whose text is marked with an `XE` field throughout the document. + * @param markAllEntriesOptions - Optional. The options for marking all entries. + */ + markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.IndexCollectionData; + } + /** + * Represents options for creating an index in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexAddOptions { + /** + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberOfColumns?: number; + /** + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightAlignPageNumbers?: boolean; + /** + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.IndexType | "Indent" | "Runin"; + } + /** + * Represents options for marking all index entries in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexMarkAllEntriesOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + } + /** + * Represents options for marking an index entry in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexMarkEntryOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + /** + * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reading?: boolean; + } + /** + * Specifies the type of separator to use for headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + } + /** + * Represents the type of line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineSpacing { + /** + * Represents single line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Represents 1.5 line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onePt5 = "OnePt5", + /** + * Represents double line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + double = "Double", + /** + * Represents at least line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * Represents exact line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + /** + * Represents multiple line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + multiple = "Multiple", + } + /** + * Represents the alignment of a tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list = "List", + } + /** + * Represents the type of tight wrap for a text box. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextboxTightWrap { + /** + * Represents that there's no tight wrap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents tight wrap around all lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", + /** + * Represents tight wrap around the first and last lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstAndLastLines = "FirstAndLastLines", + /** + * Represents tight wrap around the first line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstLineOnly = "FirstLineOnly", + /** + * Represents tight wrap around the last line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastLineOnly = "LastLineOnly", + } + /** + * Specifies the filter type for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + middleDot = "MiddleDot", + } + /** + * Specifies the area of a table to which to apply special style formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ConditionCode { + /** + * Applies formatting to the first row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstRow = "FirstRow", + /** + * Applies formatting to the last row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastRow = "LastRow", + /** + * Applies formatting to odd-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddRowBanding = "OddRowBanding", + /** + * Applies formatting to even-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenRowBanding = "EvenRowBanding", + /** + * Applies formatting to the first column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstColumn = "FirstColumn", + /** + * Applies formatting to the last column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastColumn = "LastColumn", + /** + * Applies formatting to odd-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddColumnBanding = "OddColumnBanding", + /** + * Applies formatting to even-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenColumnBanding = "EvenColumnBanding", + /** + * Applies formatting to the last cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRightCell = "TopRightCell", + /** + * Applies formatting to the first cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeftCell = "TopLeftCell", + /** + * Applies formatting to the last cell in the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRightCell = "BottomRightCell", + /** + * Applies formatting to first cell in the last row of the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeftCell = "BottomLeftCell", + } + /** + * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DeleteCells { + /** + * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftLeft = "ShiftLeft", + /** + * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftUp = "ShiftUp", + /** + * Delete the entire row of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireRow = "EntireRow", + /** + * Delete the entire column of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireColumn = "EntireColumn", + } + /** + * Specifies the rule for determining the height of the specified cells or rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RowHeightRule { + /** + * The row height is adjusted to accommodate the tallest value in the row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", + /** + * The row height is set to a minimum value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * The row height is set to an exact value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + } + /** + * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableDirection { + /** + * The table is arranged with the first column in the rightmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * The table is arranged with the first column in the leftmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the character used to separate fields in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFieldSeparator { + /** + * Uses the paragraph marker. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Uses the tab. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tab = "Tab", + /** + * Uses the comma. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comma = "Comma", + /** + * Uses the default list separator. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultListSeparator = "DefaultListSeparator", + } + /** + * Specifies the table format to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormatType { + /** + * Applies no formatting to the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the Simple1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the Simple2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the Simple3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the Classic1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the Classic2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the Classic3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the Classic4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the Colorful1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the Colorful2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the Colorful3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the Columns1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the Columns2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the Columns3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the Columns4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the Columns5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the Grid1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the Grid2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the Grid3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the Grid4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the Grid5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the Grid6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the Grid7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the Grid8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the List1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the List2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the List3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the List4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the List5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the List6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the List7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the List8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D Effects1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D Effects2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D Effects3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the Contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the Elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the Professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the Subtle1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the Subtle2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the Web1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the Web2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the Web3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableAutoFormatOptions { + /** + * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyBorders?: boolean; + /** + * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyColor?: boolean; + /** + * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFirstColumn?: boolean; + /** + * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFont?: boolean; + /** + * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyHeadingRows?: boolean; + /** + * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastColumn?: boolean; + /** + * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastRow?: boolean; + /** + * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyShading?: boolean; + /** + * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoFit?: boolean; + /** + * If provided, specifies the format to apply. The default value is `simple1`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + } + /** + * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableCellCollectionSplitOptions { + /** + * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mergeBeforeSplit?: boolean; + /** + * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numColumns?: number; + /** + * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numRows?: number; + } + /** + * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableCellFormulaOptions { + /** + * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formula?: string; + /** + * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numFormat?: string; + } + /** + * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableConvertToTextOptions { + /** + * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nestedTables?: boolean; + /** + * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + } + /** + * Represents the options for the {@link Word.Table | Table.sort} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableSortOptions { + /** + * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectionalSort?: boolean; + /** + * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caseSensitive?: boolean; + /** + * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + excludeHeader?: boolean; + /** + * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber?: string; + /** + * If provided, specifies the second field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber2?: string; + /** + * If provided, specifies the third field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber3?: string; + /** + * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreArabicThe?: boolean; + /** + * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreDiacritics?: boolean; + /** + * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreHebrew?: boolean; + /** + * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreKashida?: boolean; + /** + * If provided, specifies the sorting language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + } + /** + * Represents a list of the names of all the available fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class FontNameCollection 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; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the font name at the specified index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The zero-based index of the font name to retrieve. + */ + getItemAt(index: number): OfficeExtension.ClientResult; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateCollection 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.ListTemplate[]; + /** + * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for adding a new list template. + */ + add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + /** + * Gets a `ListTemplate` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `ListTemplate` object. + */ + getItem(index: number): Word.ListTemplate; + /** + * 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.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateCollectionData; + } + /** + * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListTemplateCollectionAddOptions { + /** + * If provided, specifies the name of the list template to be added. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered?: boolean; + } + /** + * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateGallery 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; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryData; + } + /** + * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateGalleryCollection 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.ListTemplateGallery[]; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of list template gallery to retrieve. + */ + getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of list template gallery to retrieve. + */ + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `ListTemplateGallery` object. + */ + getItem(index: number): Word.ListTemplateGallery; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + } + /** + * Describes the types of list template galleries available. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListTemplateGalleryType { + /** + * Represents the bullet list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bullets = "Bullets", + /** + * Represents the number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + number = "Number", + /** + * Represents the outline number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered = "OutlineNumbered", + } + /** + * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CoauthoringLockType { + /** + * Reserved for future use. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents that the lock is a reservation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reservation = "Reservation", + /** + * Represents that the lock is ephemeral. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ephemeral = "Ephemeral", + /** + * Represents that the lock has changed. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + changed = "Changed", + } + /** + * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EditorType { + /** + * Represents the current user of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + current = "Current", + /** + * Represents the Editors group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + editors = "Editors", + /** + * Represents all users who open a document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + everyone = "Everyone", + /** + * Represents the Owners group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owners = "Owners", + } + 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. + */ + $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. + */ + $skip?: number; + } + /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ + export interface EditorUpdateData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ + export interface ConflictCollectionUpdateData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ + export interface ConflictUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + export interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + export interface ApplicationUpdateData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage?: boolean; + } + /** 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + export interface BorderUpdateData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ + export interface BorderUniversalUpdateData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + export interface BorderCollectionUpdateData { + /** + * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderColor?: string; + /** + * Specifies the border type of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + /** + * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderColor?: string; + /** + * Specifies the border type of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ + export interface BorderUniversalCollectionUpdateData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ + export interface BreakUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ + export interface BreakCollectionUpdateData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ + export interface BuildingBlockUpdateData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: string; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + export interface CheckboxContentControlUpdateData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ + export interface CoauthoringLockUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ + export interface CoauthoringLockCollectionUpdateData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ + export interface CoauthorCollectionUpdateData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ + export interface CoauthoringUpdateUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ + export interface CoauthoringUpdateCollectionUpdateData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + export interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + export interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + export interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ + export interface ConditionalStyleUpdateData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding?: number; + } + /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ + export interface XmlMappingUpdateData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + } + /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ + export interface CustomXmlPrefixMappingCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ + export interface CustomXmlSchemaCollectionUpdateData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ + export interface CustomXmlValidationErrorCollectionUpdateData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ + export interface CustomXmlValidationErrorUpdateData { + /** + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + node?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ + export interface CustomXmlNodeCollectionUpdateData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ + export interface CustomXmlNodeUpdateData { + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: string; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + export interface ContentControlUpdateData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + /** + * 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 date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + /** + * 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; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * 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] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + export interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + export interface ContentControlListItemUpdateData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + export interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + export interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + export interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ + export interface CustomXmlPartUpdateData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + export interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + export interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ + export interface DocumentUpdateData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowUpdateData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * 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; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies whether grammatical errors are marked by a wavy green line in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areGrammaticalErrorsShown?: boolean; + /** + * Specifies whether to use the default math settings when creating new equations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areMathDefaultsUsed?: boolean; + /** + * Specifies whether to disable features introduced after a specified version. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areNewerFeaturesDisabled?: boolean; + /** + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areSpellingErrorsShown?: boolean; + /** + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areStylesUpdatedOnOpen?: boolean; + /** + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areTrueTypeFontsEmbedded?: boolean; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + consecutiveHyphensLimit?: number; + /** + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultTabStop?: number; + /** + * Specifies the browser frame for displaying a webpage via hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultTargetFrame?: string; + /** + * Specifies whether Word should not embed common system fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + doNotEmbedSystemFonts?: boolean; + /** + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + encryptionProvider?: string; + /** + * Specifies the East Asian language used for line breaking. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether Word shows the next heading level when the previous is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formattingIsNextLevelShown?: boolean; + /** + * Specifies whether to show user-defined styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formattingIsUserStyleNameShown?: boolean; + /** + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridDistanceHorizontal?: number; + /** + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridDistanceVertical?: number; + /** + * Specifies whether the character grid starts from the upper-left corner of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridIsOriginFromMargin?: boolean; + /** + * Specifies the horizontal origin point for the invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridOriginHorizontal?: number; + /** + * Specifies the vertical origin point for the invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridOriginVertical?: number; + /** + * Specifies the interval for horizontal character gridlines in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridSpaceBetweenHorizontalLines?: number; + /** + * Specifies the interval for vertical character gridlines in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridSpaceBetweenVerticalLines?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies the width of the hyphenation zone, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenationZone?: number; + /** + * Specifies whether automatic formatting options override formatting restrictions. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAutoFormatOverrideOn?: boolean; + /** + * Specifies whether charts in the active document use cell-reference data-point tracking. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isChartDataPointTracked?: boolean; + /** + * Specifies whether the compatibility option specified by the `type` property is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isCompatible?: boolean; + /** + * Specifies whether the document is final. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFinal?: boolean; + /** + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFontsSubsetSaved?: boolean; + /** + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormsDataPrinted?: boolean; + /** + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormsDataSaved?: boolean; + /** + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isGrammarChecked?: boolean; + /** + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isKerningByAlgorithm?: boolean; + /** + * Specifies whether to embed speech and handwriting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLinguisticDataEmbedded?: boolean; + /** + * Specifies whether Word optimizes the document for Word 97. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isOptimizedForWord97?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isPostScriptPrintedOverText?: boolean; + /** + * Specifies whether users can change the Quick Style set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isQuickStyleSetLocked?: boolean; + /** + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isReadOnlyRecommended?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSnappedToGrid?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSnappedToShapes?: boolean; + /** + * Specifies whether spelling has been checked throughout the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSpellingChecked?: boolean; + /** + * Specifies whether formatting restrictions are enforced in a protected document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isStyleEnforced?: boolean; + /** + * Specifies whether users can change the document theme. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isThemeLocked?: boolean; + /** + * Specifies whether the document was created or opened by the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isUserControl?: boolean; + /** + * Specifies the character spacing adjustment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies the format type that Microsoft Word uses when automatically formatting the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + /** + * Specifies the kinsoku characters after which Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakBefore?: string; + /** + * Sets a password that must be supplied to open the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + password?: string; + /** + * Specifies whether revision marks are printed with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + printRevisions?: boolean; + /** + * Specifies the width of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingLayoutSizeX?: number; + /** + * Specifies the height of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingLayoutSizeY?: number; + /** + * Specifies whether pages in reading layout view are frozen for handwritten markup. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingModeIsLayoutFrozen?: boolean; + /** + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + removePersonalInformationOnSave?: boolean; + /** + * Specifies the encoding used when saving the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies the encoding for saving as encoded text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; + /** + * Specifies whether to track formatting changes when change tracking is on. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackFormatting?: boolean; + /** + * Specifies whether to mark moved text when Track Changes is on. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackMoves?: boolean; + /** + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackRevisions?: boolean; + /** + * Specifies whether to remove or store date and time metadata for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackedChangesAreDateAndTimeRemoved?: boolean; + /** + * Sets a password for saving changes to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + writePassword?: string; + /** + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlAreAdvancedErrorsShown?: boolean; + /** + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlIsXsltUsedWhenSaving?: boolean; + /** + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlSaveThroughXSLT?: string; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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({ ... })`. */ + export interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** 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] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + export interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + export interface FontUpdateData { + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fill?: Word.Interfaces.FillFormatUpdateData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + /** + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allCaps?: boolean; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + engrave?: boolean; + /** + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow?: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor?: string; + } + /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ + export interface HeadingStyleUpdateData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + } + /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ + export interface HeadingStyleCollectionUpdateData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { /** - * Specify the number of items in the queried collection to be included in the result. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $top?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * 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. + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $skip?: number; - } - /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ - export interface EditorUpdateData { + address?: string; /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeUpdateData; + emailSubject?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ - export interface ConflictCollectionUpdateData { - items?: Word.Interfaces.ConflictData[]; - } - /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ - export interface ConflictUpdateData { + screenTip?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - export interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ - export interface ApplicationUpdateData { + subAddress?: string; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + target?: string; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + textToDisplay?: string; } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - export interface BodyUpdateData { + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + export interface InlinePictureUpdateData { /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontUpdateData; + altTextDescription?: string; /** - * 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. + * Specifies a string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - style?: string; + altTextTitle?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ - export interface BorderUpdateData { + height?: number; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - color?: string; + hyperlink?: string; /** - * Specifies the border type for the border. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + lockAspectRatio?: boolean; /** - * Specifies whether the border is visible. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - visible?: boolean; + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + export interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ + export interface LinkFormatUpdateData { /** - * Specifies the width for the border. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ - export interface BorderUniversalUpdateData { + isAutoUpdated?: boolean; /** - * Specifies the graphical page-border design for the document. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + isLocked?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + sourceFullName?: string; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + export interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + export interface ListItemUpdateData { /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + export interface ListLevelUpdateData { /** - * Specifies whether the border is visible. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isVisible?: boolean; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the line style of the border. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the line width of an object's border. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - export interface BorderCollectionUpdateData { + linkedStyle?: string; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the number format for the specified list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderColor?: string; + numberFormat?: string; /** - * Specifies the border type of the inside borders. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + numberPosition?: number; /** - * Specifies the width of the inside borders. + * Specifies the number style for the list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderColor?: string; + resetOnHigher?: number; /** - * Specifies the border type of the outside borders. + * Specifies the starting number for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + startAt?: number; /** - * Specifies the width of the outside borders. + * Specifies the tab position for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; } - /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ - export interface BorderUniversalCollectionUpdateData { - items?: Word.Interfaces.BorderUniversalData[]; + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + export interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - export interface BreakUpdateData { + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + export interface ListTemplateUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - export interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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 `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ - export interface BuildingBlockUpdateData { + /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + export interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ + export interface OleFormatUpdateData { /** - * Specifies the description for the building block. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + classType?: string; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + iconIndex?: number; /** - * Specifies the name of the building block. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + iconLabel?: string; /** - * Specifies the contents of the building block. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - export interface CheckboxContentControlUpdateData { + iconName?: string; /** - * Specifies the current state of the checkbox. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; + isFormattingPreservedOnUpdate?: boolean; } - /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ - export interface CoauthoringLockUpdateData { + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + export interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + export interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ + export interface WindowUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ - export interface CoauthoringLockCollectionUpdateData { - items?: Word.Interfaces.CoauthoringLockData[]; - } - /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ - export interface CoauthorCollectionUpdateData { - items?: Word.Interfaces.CoauthorData[]; - } - /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ - export interface CoauthoringUpdateUpdateData { + next?: Word.Interfaces.WindowUpdateData; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ - export interface CoauthoringUpdateCollectionUpdateData { - items?: Word.Interfaces.CoauthoringUpdateData[]; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - export interface CommentUpdateData { + previous?: Word.Interfaces.WindowUpdateData; /** - * Specifies the comment's content range. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + areRulersDisplayed?: boolean; /** - * Specifies the comment's content as plain text. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + areThumbnailsDisplayed?: boolean; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - export interface CommentCollectionUpdateData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - export interface CommentContentRangeUpdateData { + caption?: string; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + horizontalPercentScrolled?: number; /** - * 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. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + isDocumentMapVisible?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ - export interface CommentReplyUpdateData { + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the commentReply's content range. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + isLeftScrollBarDisplayed?: boolean; /** - * Gets the parent comment of this reply. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentComment?: Word.Interfaces.CommentUpdateData; + isRightRulerDisplayed?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; - } - /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - export interface CommentReplyCollectionUpdateData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ - export interface ConditionalStyleUpdateData { + isSplit?: boolean; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomPadding?: number; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: number; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * Specifies whether the window is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightPadding?: number; + isVisible?: boolean; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: number; - } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - export interface XmlMappingUpdateData { + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies the vertical split percentage for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + splitVertical?: number; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies the width of the style area in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; - } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - export interface CustomXmlPrefixMappingCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - export interface CustomXmlSchemaCollectionUpdateData { - items?: Word.Interfaces.CustomXmlSchemaData[]; + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled?: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; } - /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - export interface CustomXmlValidationErrorCollectionUpdateData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + export interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - export interface CustomXmlValidationErrorUpdateData { + /** 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] + */ + 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] + */ + 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] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - export interface CustomXmlNodeCollectionUpdateData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - export interface CustomXmlNodeUpdateData { + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + leftIndent?: number; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + lineSpacing?: number; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + lineUnitAfter?: number; /** - * Gets the object representing the part associated with this node. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + lineUnitBefore?: number; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + outlineLevel?: number; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + rightIndent?: number; /** - * Specifies the value of the current node. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - nodeValue?: string; + spaceAfter?: number; /** - * Specifies the text for the current node. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - export interface ContentControlUpdateData { + spaceBefore?: number; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the style name for the paragraph. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + style?: string; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + export interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + export interface ParagraphFormatUpdateData { /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontUpdateData; + firstLineIndent?: number; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + keepTogether?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + keepWithNext?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + leftIndent?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + lineSpacing?: number; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + lineUnitAfter?: number; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotDelete?: boolean; + lineUnitBefore?: number; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotEdit?: boolean; + mirrorIndents?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - color?: string; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - placeholderText?: string; + rightIndent?: number; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - removeWhenEdited?: boolean; + spaceAfter?: number; /** - * Specifies the style name for the content control. 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. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - style?: string; + spaceBefore?: number; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + widowControl?: boolean; + } + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + export interface RangeUpdateData { /** - * Specifies a tag to identify a content control. + * 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] */ - tag?: string; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the title for a content control. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - export interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - export interface ContentControlListItemUpdateData { + listFormat?: Word.Interfaces.ListFormatUpdateData; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - export interface ContentControlListItemCollectionUpdateData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - export interface CustomPropertyUpdateData { + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - export interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - export interface CustomXmlPartUpdateData { + combineCharacters?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - export interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - export interface CustomXmlPartScopedCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - export interface DocumentUpdateData { + end?: number; /** - * Gets the active window for the document. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowUpdateData; + fitTextWidth?: number; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + grammarChecked?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + hasNoProofing?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the properties of the document. + * 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. * * @remarks * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + hyperlink?: string; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + id?: string; /** - * Specifies if the edits in the document are automatically saved. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the ChangeTracking mode. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + languageDetected?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - export interface DocumentCreatedUpdateData { + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + showAll?: boolean; /** - * Gets the properties of the document. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - export interface DocumentPropertiesUpdateData { + spellingChecked?: boolean; /** - * Specifies the author of the document. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + start?: number; /** - * Specifies the category of the document. + * Specifies the style name for the range. 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - category?: string; + style?: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - comments?: string; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the company of the document. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: string; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + export interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + export interface SearchOptionsUpdateData { /** - * Specifies the format of the document. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - format?: string; + ignorePunct?: boolean; /** - * Specifies the keywords of the document. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - keywords?: string; + ignoreSpace?: boolean; /** - * Specifies the manager of the document. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - manager?: string; + matchCase?: boolean; /** - * Specifies the subject of the document. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subject?: string; + matchPrefix?: boolean; /** - * Specifies the title of the document. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title?: string; - } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - export interface FieldUpdateData { + matchSuffix?: boolean; /** - * Gets the field's result data. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeUpdateData; + matchWholeWord?: boolean; /** - * Specifies the field's code instruction. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: string; + matchWildcards?: boolean; + } + /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ + export interface SectionUpdateData { /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: string; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Returns a `PageSetup` object that's associated with the section. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + pageSetup?: Word.Interfaces.PageSetupUpdateData; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - showCodes?: boolean; + protectedForForms?: boolean; } - /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ - export interface FieldCollectionUpdateData { - items?: Word.Interfaces.FieldData[]; + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + export interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; } - /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ - export interface FontUpdateData { + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + export interface SettingUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - fill?: Word.Interfaces.FillFormatUpdateData; + value?: any; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + export interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + export interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + export interface StyleUpdateData { /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - glow?: Word.Interfaces.GlowFormatUpdateData; + borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - line?: Word.Interfaces.LineFormatUpdateData; + font?: Word.Interfaces.FontUpdateData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; + frame?: Word.Interfaces.FrameUpdateData; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatUpdateData; + linkStyle?: Word.Interfaces.StyleUpdateData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - allCaps?: boolean; + shading?: Word.Interfaces.ShadingUpdateData; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - bold?: boolean; + tableStyle?: Word.Interfaces.TableStyleUpdateData; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - color?: string; + baseStyle?: string; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + hasProofing?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + locked?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - doubleStrikeThrough?: boolean; + priority?: number; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emboss?: boolean; + quickStyle?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + unhideWhenUsed?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - engrave?: boolean; + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + export interface ShadingUpdateData { /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - hidden?: boolean; + backgroundPatternColor?: string; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - highlightColor?: string; + foregroundPatternColor?: string; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + export interface ShadingUniversalUpdateData { /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + backgroundPatternColor?: string; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + foregroundPatternColor?: string; /** - * Specifies a value that represents the name of the font. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + export interface TableUpdateData { /** - * Specifies the font name in a right-to-left language document. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameBidirectional?: string; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the East Asian font name. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameFarEast?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + description?: string; /** - * Specifies the number form setting for an OpenType font. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + headerRowCount?: number; /** - * Specifies the number spacing setting for the font. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - outline?: boolean; + shadingColor?: string; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the style name for the table. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - position?: number; + style?: string; /** - * Specifies the scaling percentage applied to the font. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - scaling?: number; + styleBandedColumns?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shadow?: boolean; + styleBandedRows?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sizeBidirectional?: number; + styleFirstColumn?: boolean; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - smallCaps?: boolean; + styleLastColumn?: boolean; /** - * Specifies the spacing between characters. + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + title?: string; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + values?: string[][]; /** - * Specifies the stylistic set for the font. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - subscript?: boolean; + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + export interface TableStyleUpdateData { /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - superscript?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + allowBreakAcrossPage?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - underlineColor?: string; - } - /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ - export interface HeadingStyleUpdateData { + bottomCellMargin?: number; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: number; + /** + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: number; + columnStripe?: number; /** - * Specifies the name of style for a heading. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ - export interface HeadingStyleCollectionUpdateData { - items?: Word.Interfaces.HeadingStyleData[]; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - export interface HyperlinkUpdateData { + isBreakAcrossPagesAllowed?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: number; + /** + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + leftIndent?: number; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: number; + /** + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + rowStripe?: number; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: number; + } + /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ + export interface TabStopCollectionUpdateData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + export interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + export interface TableColumnUpdateData { + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: string; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: string; + preferredWidth?: number; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: string; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; + width?: number; } - /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ - export interface HyperlinkCollectionUpdateData { - items?: Word.Interfaces.HyperlinkData[]; + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + export interface TableColumnCollectionUpdateData { + items?: Word.Interfaces.TableColumnData[]; } - /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ - export interface InlinePictureUpdateData { + /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ + export interface TableOfAuthoritiesUpdateData { /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + bookmark?: string; /** - * Specifies a string that contains the title for the inline image. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: string; + category?: number; /** - * Specifies a number that describes the height of the inline image. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + entrySeparator?: string; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + isCategoryHeaderIncluded?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ - export interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ - export interface LinkFormatUpdateData { + isPassimUsed?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + pageNumberSeparator?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + pageRangeSeparator?: string; /** - * Specifies if the linked picture is saved with the document. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + sequenceName?: string; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: string; - } - /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ - export interface ListCollectionUpdateData { - items?: Word.Interfaces.ListData[]; - } - /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ - export interface ListItemUpdateData { + sequenceSeparator?: string; /** - * Specifies the level of the item in the list. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } - /** 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] - */ - font?: Word.Interfaces.FontUpdateData; + /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ + export interface TableOfAuthoritiesCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ + export interface TableOfAuthoritiesCategoryCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ + export interface TableOfContentsUpdateData { /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + areFieldsUsed?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the number style for the list level object. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + arePageNumbersIncluded?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + lowerHeadingLevel?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + tableId?: string; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + upperHeadingLevel?: number; } - /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - export interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; + /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ + export interface TableOfContentsCollectionUpdateData { + items?: Word.Interfaces.TableOfContentsData[]; } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - export interface ListTemplateUpdateData { + /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ + export interface TableOfFiguresUpdateData { /** - * Specifies the name of the list template. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies whether the list template is outline numbered. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - export interface NoteItemUpdateData { + areFieldsUsed?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + areHyperlinksUsedOnWeb?: boolean; /** - * Represents a footnote or endnote reference in the main document. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - export interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ - export interface OleFormatUpdateData { + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + arePageNumbersIncluded?: boolean; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel?: string; + captionLabel?: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: string; + isLabelIncluded?: boolean; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate?: boolean; - } - /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ - export interface PageCollectionUpdateData { - items?: Word.Interfaces.PageData[]; - } - /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ - export interface PaneCollectionUpdateData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ - export interface WindowUpdateData { + lowerHeadingLevel?: number; /** - * Gets the next document window in the collection of open document windows. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.WindowUpdateData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the previous document window in the collection open document windows. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.WindowUpdateData; + tableId?: string; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ + export interface TableOfFiguresCollectionUpdateData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + export interface TableRowUpdateData { /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areThumbnailsDisplayed?: boolean; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - caption?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - horizontalPercentScrolled?: number; + preferredHeight?: number; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + shadingColor?: string; /** - * Specifies whether the document map is visible. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDocumentMapVisible?: boolean; + values?: string[][]; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isEnvelopeVisible?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + export interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + export interface TableCellUpdateData { /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isHorizontalScrollBarDisplayed?: boolean; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isLeftScrollBarDisplayed?: boolean; + columnWidth?: number; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isRightRulerDisplayed?: boolean; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the window is split into multiple panes. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isSplit?: boolean; + shadingColor?: string; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalRulerDisplayed?: boolean; + value?: string; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + export interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + export interface TableBorderUpdateData { /** - * Specifies whether the window is visible. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + color?: string; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Specifies the vertical split percentage for the window. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + export interface TemplateUpdateData { + /** + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical?: number; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the width of the style area in points. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + hasNoProofing?: boolean; /** - * Specifies the state of the document window or task window. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; - } - /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ - export interface WindowCollectionUpdateData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ - export interface ParagraphUpdateData { + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + kerningByAlgorithm?: boolean; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemUpdateData; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * 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}. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + noLineBreakAfter?: string; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + noLineBreakBefore?: string; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + saved?: boolean; + } + /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ + export interface TemplateCollectionUpdateData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + export interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ + export interface ViewUpdateData { /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + areBackgroundsDisplayed?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + areCommentsDisplayed?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + areEditableRangesShaded?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + areFieldCodesDisplayed?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + areFormatChangesDisplayed?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the style name for the paragraph. 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. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ - export interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - export interface ParagraphFormatUpdateData { + areOtherAuthorsVisible?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + areTableGridlinesDisplayed?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + isDraft?: boolean; /** - * Specifies the left indent. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + isFormatDisplayed?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + isFullScreen?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + isInConflictMode?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + isInPanning?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + isInReadingLayout?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + isMailMergeDataView?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + isMainTextLayerVisible?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + isPointerShownAsMagnifier?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; - } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - export interface RangeUpdateData { + isReadingLayoutActualView?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + isXmlMarkupVisible?: boolean; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the character width of the range. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies if the range contains combined characters. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + revisionsBalloonWidth?: number; /** - * Specifies the ending character position of the range. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { /** - * Specifies the formatting for horizontal text set within vertical text. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + body?: Word.Interfaces.BodyUpdateData; /** - * 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. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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] + * [Api set: WordApiDesktop 1.2] */ - hyperlink?: string; + canvas?: Word.Interfaces.CanvasUpdateData; /** - * Specifies the ID for the range. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - id?: string; + fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageDetected?: boolean; + parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Specifies an East Asian language for the range. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - showAll?: boolean; + allowOverlap?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spellingChecked?: boolean; + altTextDescription?: string; /** - * Specifies the starting character position of the range. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - start?: number; + geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies the style name for the range. 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. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + height?: number; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + heightRelative?: number; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; - } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - export interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - export interface SearchOptionsUpdateData { + left?: number; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - ignorePunct?: boolean; + leftRelative?: number; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - ignoreSpace?: boolean; + lockAspectRatio?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchCase?: boolean; + name?: string; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchPrefix?: boolean; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchSuffix?: boolean; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWholeWord?: boolean; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWildcards?: boolean; - } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - export interface SectionUpdateData { + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyUpdateData; + rotation?: number; /** - * Returns a `PageSetup` object that's associated with the section. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + top?: number; /** - * Specifies if the section is protected for forms. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - protectedForForms?: boolean; - } - /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ - export interface SectionCollectionUpdateData { - items?: Word.Interfaces.SectionData[]; + topRelative?: number; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; } - /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ - export interface SettingUpdateData { + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + export interface ShapeGroupUpdateData { /** - * Specifies the value of the setting. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - value?: any; + shape?: Word.Interfaces.ShapeUpdateData; } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - export interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + export interface CanvasUpdateData { + /** + * Gets the Shape object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeUpdateData; } - /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - export interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - export interface StyleUpdateData { + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + export interface ShapeFillUpdateData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + backgroundColor?: string; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + foregroundColor?: string; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frame?: Word.Interfaces.FrameUpdateData; + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + export interface TextFrameUpdateData { /** - * Specifies a link between a paragraph and a character style. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - linkStyle?: Word.Interfaces.StyleUpdateData; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + bottomMargin?: number; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + leftMargin?: number; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingUpdateData; + noTextRotation?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies whether the style is automatically redefined based on the selection. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - automaticallyUpdate?: boolean; + rightMargin?: number; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - baseStyle?: string; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasProofing?: boolean; + wordWrap?: boolean; + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + export interface ShapeTextWrapUpdateData { /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + bottomDistance?: number; /** - * Specifies an East Asian language for the style. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + leftDistance?: number; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - locked?: boolean; + rightDistance?: number; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + /** + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: string; + topDistance?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + export interface ReviewerUpdateData { + /** + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + isVisible?: boolean; + } + /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + export interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + export interface RevisionsFilterUpdateData { /** - * Specifies the priority. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: number; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + export interface RepeatingSectionItemUpdateData { /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ + export interface RevisionUpdateData { /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - export interface ShadingUpdateData { + movedRange?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ + export interface RevisionCollectionUpdateData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + export interface DatePickerContentControlUpdateData { /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ - export interface ShadingUniversalUpdateData { + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + color?: string; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - export interface TableUpdateData { + dateDisplayFormat?: string; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the description of the table. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isTemporary?: boolean; /** - * Specifies the number of header rows. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + lockContentControl?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lockContents?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + tag?: string; /** - * Specifies the style name for the table. 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. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + export interface PictureContentControlUpdateData { /** - * Specifies whether the table has banded columns. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies whether the table has banded rows. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether the table has a first column with a special style. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether the table has a last column with a special style. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + color?: string; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + isTemporary?: boolean; /** - * Specifies the title of the table. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + lockContentControl?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + lockContents?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + tag?: string; /** - * Specifies the width of the table in points. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + title?: string; } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - export interface TableStyleUpdateData { + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + export interface GroupContentControlUpdateData { /** - * Specifies the table's alignment against the page margin. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnStripe?: number; + color?: string; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isBreakAcrossPagesAllowed?: boolean; + isTemporary?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + lockContentControl?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftIndent?: number; + lockContents?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + tag?: string; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe?: number; + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + export interface BuildingBlockGalleryContentControlUpdateData { /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ - export interface TabStopCollectionUpdateData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - export interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; - } - /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ - export interface TableColumnUpdateData { + range?: Word.Interfaces.RangeUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + buildingBlockCategory?: string; /** - * Specifies the width of the column, in points. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - export interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ - export interface TableOfAuthoritiesUpdateData { + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark?: string; + color?: string; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: number; + isTemporary?: boolean; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entrySeparator?: string; + lockContentControl?: boolean; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCategoryHeaderIncluded?: boolean; + lockContents?: boolean; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEntryFormattingKept?: boolean; + tag?: string; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPassimUsed?: boolean; + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + export interface RepeatingSectionContentControlUpdateData { /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName?: string; + xmlapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator?: string; + allowInsertDeleteSection?: boolean; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ - export interface TableOfAuthoritiesCollectionUpdateData { - items?: Word.Interfaces.TableOfAuthoritiesData[]; - } - /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ - export interface TableOfAuthoritiesCategoryCollectionUpdateData { - items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; - } - /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ - export interface TableOfContentsUpdateData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + color?: string; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + isTemporary?: boolean; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + lockContentControl?: boolean; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + lockContents?: boolean; /** - * Specifies whether page numbers are included in the table of contents. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + tag?: string; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + title?: string; + } + /** An interface for updating data on the `ReadabilityStatisticCollection` object, for use in `readabilityStatisticCollection.set({ ... })`. */ + export interface ReadabilityStatisticCollectionUpdateData { + items?: Word.Interfaces.ReadabilityStatisticData[]; + } + /** An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`. */ + export interface WebSettingsUpdateData { /** - * Specifies the character between entries and their page numbers in the table of contents. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + allowPng?: boolean; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ - export interface TableOfContentsCollectionUpdateData { - items?: Word.Interfaces.TableOfContentsData[]; - } - /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ - export interface TableOfFiguresUpdateData { + organizeInFolder?: boolean; /** - * Specifies whether built-in heading styles are used for the table of figures. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + pixelsPerInch?: number; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + relyOnCSS?: boolean; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Specifies whether page numbers are included in the table of figures. + * Specifies the target browser for documents viewed in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + useLongFileNames?: boolean; + } + /** An interface for updating data on the `XmlNodeCollection` object, for use in `xmlNodeCollection.set({ ... })`. */ + export interface XmlNodeCollectionUpdateData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`. */ + export interface XmlNodeUpdateData { /** - * Specifies the label that identifies the items to be included in the table of figures. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - captionLabel?: string; + nodeValue?: string; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLabelIncluded?: boolean; + placeholderText?: string; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + text?: string; + } + /** An interface for updating data on the `HtmlDivision` object, for use in `htmlDivision.set({ ... })`. */ + export interface HtmlDivisionUpdateData { /** - * Specifies the character between entries and their page numbers in the table of figures. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + leftIndent?: number; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + rightIndent?: number; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ - export interface TableOfFiguresCollectionUpdateData { - items?: Word.Interfaces.TableOfFiguresData[]; - } - /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - export interface TableRowUpdateData { + spaceAfter?: number; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + spaceBefore?: number; + } + /** An interface for updating data on the `HtmlDivisionCollection` object, for use in `htmlDivisionCollection.set({ ... })`. */ + export interface HtmlDivisionCollectionUpdateData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + export interface FrameUpdateData { /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the preferred height of the row in points. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + height?: number; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ - export interface TableRowCollectionUpdateData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ - export interface TableCellUpdateData { + horizontalDistanceFromText?: number; /** - * Gets the body object of the cell. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + horizontalPosition?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + lockAnchor?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the text of the cell. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + textWrap?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - export interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - export interface TableBorderUpdateData { + verticalDistanceFromText?: number; /** - * Specifies the table border color. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + verticalPosition?: number; /** - * Specifies the type of the table border. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + width?: number; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; } - /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ - export interface TemplateUpdateData { + /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ + export interface FrameCollectionUpdateData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ + export interface DocumentLibraryVersionCollectionUpdateData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ + export interface ListFormatUpdateData { /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Specifies the line break control level for the document. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + listLevelNumber?: number; + } + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + export interface FillFormatUpdateData { /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the character spacing adjustment for the template. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + gradientAngle?: number; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + rotateWithObject?: boolean; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + textureHorizontalScale?: number; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - export interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - export interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ - export interface ViewUpdateData { + textureOffsetX?: number; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + textureOffsetY?: number; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + textureTile?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + textureVerticalScale?: number; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + export interface GlowFormatUpdateData { /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + color?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether field codes are displayed. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + radius?: number; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + export interface LineFormatUpdateData { /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies whether table gridlines are displayed. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the column width in Reading mode. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies whether the window is in full-screen view. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + insetPen?: boolean; /** - * Specifies whether the document is in conflict mode view. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + isVisible?: boolean; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + transparency?: number; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + export interface ReflectionFormatUpdateData { /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + blur?: number; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + offset?: number; /** - * Specifies whether XML tags are visible in the document. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + size?: number; /** - * Specifies the display mode for tracked changes. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + transparency?: number; /** - * Specifies the page color in Reading mode. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ + export interface ColorFormatUpdateData { /** - * Specifies the page movement type. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + brightness?: number; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies the width of the revision balloons. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + rgb?: string; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + export interface ShadowFormatUpdateData { /** - * Specifies the document element displayed in print layout view. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the active window pane. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + blur?: number; /** - * Specifies the view type. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - export interface ShapeUpdateData { + isVisible?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + obscured?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasUpdateData; + offsetX?: number; /** - * Returns the fill formatting of the shape. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillUpdateData; + offsetY?: number; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + rotateWithShape?: boolean; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + size?: number; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Gets the text frame object of the shape. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + transparency?: number; /** - * Returns the text wrap formatting of the shape. + * Specifies the shape shadow type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + export interface ThreeDimensionalFormatUpdateData { /** - * Specifies whether a given shape can overlap other shapes. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies a string that represents the alternative text associated with the shape. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the depth of the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + bevelBottomDepth?: number; /** - * The height, in points, of the shape. + * Specifies the inset size for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + bevelBottomInset?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the depth of the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + bevelTopDepth?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the inset size for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + bevelTopInset?: number; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * The name of the shape. + * Specifies the width of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + contourWidth?: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the depth of the shape's extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + depth?: number; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the amount of perspective for a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + fieldOfView?: number; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isPerspective?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + isVisible?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the angle of the lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + lightAngle?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the position of the light source relative to the extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * The width, in points, of the shape. + * Specifies the intensity of the extrusion lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the extrusion surface material. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - export interface ShapeGroupUpdateData { + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets the Shape object associated with the group. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - export interface CanvasUpdateData { + projectText?: boolean; /** - * Gets the Shape object associated with the canvas. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - export interface ShapeCollectionUpdateData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - export interface ShapeFillUpdateData { + rotationX?: number; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + rotationY?: number; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the z-axis rotation of the camera. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + rotationZ?: number; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies the position on the z-axis for the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + z?: number; } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - export interface TextFrameUpdateData { + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + export interface BibliographyUpdateData { /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies the name of the active style to use for the bibliography. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + bibliographyStyle?: string; + } + /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ + export interface SourceCollectionUpdateData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + export interface PageSetupUpdateData { /** - * Represents the bottom margin, in points, of the text frame. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** - * Represents the left margin, in points, of the text frame. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + bookFoldPrinting?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + bookFoldPrintingSheets?: number; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + bookFoldReversePrinting?: boolean; /** - * Represents the right margin, in points, of the text frame. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + bottomMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the number of characters per line in the document grid. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + charsLine?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether the first page has a different header and footer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + differentFirstPageHeaderFooter?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - export interface ShapeTextWrapUpdateData { + footerDistance?: number; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + gutter?: number; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + headerDistance?: number; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ - export interface ReviewerUpdateData { + leftMargin?: number; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ - export interface ReviewerCollectionUpdateData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ - export interface RevisionsFilterUpdateData { + linesPage?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + mirrorMargins?: boolean; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ - export interface RepeatingSectionItemUpdateData { + oddAndEvenPagesHeaderFooter?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ - export interface RevisionUpdateData { + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedRange?: Word.Interfaces.RangeUpdateData; + pageHeight?: number; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ - export interface RevisionCollectionUpdateData { - items?: Word.Interfaces.RevisionData[]; - } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - export interface DatePickerContentControlUpdateData { + pageWidth?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + rightMargin?: number; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the appearance of the content control. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + showGrid?: boolean; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + suppressEndnotes?: boolean; /** - * Specifies the format in which dates are displayed. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + topMargin?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + twoPagesOnOne?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ + export interface LineNumberingUpdateData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + countBy?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + distanceFromText?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + isActive?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the title for the content control. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + startingNumber?: number; } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - export interface PictureContentControlUpdateData { + /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ + export interface TextColumnCollectionUpdateData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ + export interface TextColumnUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + spaceAfter?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + width?: number; + } + /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ + export interface SelectionUpdateData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + end?: number; /** - * Specifies the appearance of the content control. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + fitTextWidth?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + isColumnSelectModeActive?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + isExtendModeActive?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + isStartActive?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + languageDetected?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the title for the content control. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - export interface GroupContentControlUpdateData { + start?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + text?: string; + } + /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ + export interface RangeScopedCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + export interface BookmarkUpdateData { /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -50239,7528 +58158,7706 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + end?: number; /** - * Specifies the appearance of the content control. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + start?: number; + } + /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ + export interface BookmarkCollectionUpdateData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ + export interface IndexUpdateData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ + export interface IndexCollectionUpdateData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ + export interface ListTemplateCollectionUpdateData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ + export interface ListTemplateGalleryCollectionUpdateData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** An interface describing the data returned by calling `editor.toJSON()`. */ + export interface EditorData { /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + nextRange?: Word.Interfaces.RangeData; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies a tag to identify the content control. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + id?: string; /** - * Specifies the title for the content control. + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + name?: string; } - /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - export interface BuildingBlockGalleryContentControlUpdateData { + /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ + export interface ConflictCollectionData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface describing the data returned by calling `conflict.toJSON()`. */ + export interface ConflictData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + range?: Word.Interfaces.RangeData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + export interface CritiqueAnnotationData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + export interface AnnotationData { /** - * Specifies the appearance of the content control. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + id?: string; /** - * Specifies the category for the building block content control. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - buildingBlockCategory?: string; + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; + } + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + export interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + export interface ApplicationData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + checkLanguage?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + } + /** An interface describing the data returned by calling `body.toJSON()`. */ + export interface BodyData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the collection of rich text content control objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lockContents?: boolean; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies a tag to identify the content control. + * Gets the collection of field objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tag?: string; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the title for the content control. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - title?: string; + 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] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * 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. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * 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 shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - export interface RepeatingSectionContentControlUpdateData { + /** An interface describing the data returned by calling `border.toJSON()`. */ + export interface BorderData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + color?: string; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - range?: Word.Interfaces.RangeUpdateData; + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + export interface BorderUniversalData { + /** + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + artWidth?: number; /** - * Specifies the appearance of the content control. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + color?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + inside?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + isVisible?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + export interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ + export interface BorderUniversalCollectionData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface describing the data returned by calling `break.toJSON()`. */ + export interface BreakData { /** - * Specifies a tag to identify the content control. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies the title for the content control. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + pageIndex?: number; } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - export interface FrameUpdateData { + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + export interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + export interface BuildingBlockData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + description?: string; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + id?: string; /** - * Specifies the height (in points) of the frame. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + index?: number; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + name?: string; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + export interface BuildingBlockCategoryData { /** - * Specifies if the frame is locked. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + index?: number; /** - * Specifies the relative horizontal position of the frame. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + name?: string; + } + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + export interface BuildingBlockTypeItemData { /** - * Specifies the relative vertical position of the frame. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + index?: number; /** - * Specifies if document text wraps around the frame. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + export interface CheckboxContentControlData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - verticalDistanceFromText?: number; + isChecked?: boolean; + } + /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ + export interface CoauthoringLockData { /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + owner?: Word.Interfaces.CoauthorData; /** - * Specifies the width (in points) of the frame. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies the rule used to determine the width of the frame. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ - export interface FrameCollectionUpdateData { - items?: Word.Interfaces.FrameData[]; + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; } - /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ - export interface DocumentLibraryVersionCollectionUpdateData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; + /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ + export interface CoauthoringLockCollectionData { + items?: Word.Interfaces.CoauthoringLockData[]; } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - export interface ListFormatUpdateData { + /** An interface describing the data returned by calling `coauthor.toJSON()`. */ + export interface CoauthorData { /** - * Gets the list template associated with the `ListFormat` object. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; - } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - export interface FillFormatUpdateData { + emailAddress?: string; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + id?: string; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + isMe?: boolean; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + name?: string; + } + /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ + export interface CoauthorCollectionData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ + export interface CoauthoringData { /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + authors?: Word.Interfaces.CoauthorData[]; /** - * Specifies whether the fill rotates with the shape. + * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + me?: Word.Interfaces.CoauthorData; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + updates?: Word.Interfaces.CoauthoringUpdateData[]; /** - * Specifies the vertical offset of the texture. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + canCoauthor?: boolean; /** - * Specifies whether the texture is tiled. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + canMerge?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + pendingUpdates?: boolean; + } + /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ + export interface CoauthoringUpdateData { /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + range?: Word.Interfaces.RangeData; } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - export interface GlowFormatUpdateData { + /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ + export interface CoauthoringUpdateCollectionData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + export interface CommentData { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: Word.Interfaces.ColorFormatUpdateData; + contentRange?: Word.Interfaces.CommentContentRangeData; /** - * Specifies the length of the radius for a glow effect. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - radius?: number; + replies?: Word.Interfaces.CommentReplyData[]; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - export interface LineFormatUpdateData { + authorEmail?: string; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + authorName?: string; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + content?: string; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + creationDate?: Date; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + id?: string; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + resolved?: boolean; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + export interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + export interface CommentContentRangeData { /** - * Specifies the dash style for the line. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + bold?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + hyperlink?: string; /** - * Specifies the style of the arrowhead at the end of the line. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + isEmpty?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + italic?: boolean; /** - * Specifies if to draw lines inside a shape. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - insetPen?: boolean; + strikeThrough?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isVisible?: boolean; + text?: string; /** - * Specifies the pattern applied to the line. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + export interface CommentReplyData { /** - * Specifies the line format style. + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + authorEmail?: string; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - transparency?: number; + authorName?: string; /** - * Specifies the thickness of the line in points. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - weight?: number; - } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - export interface ReflectionFormatUpdateData { + content?: string; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - blur?: number; + creationDate?: Date; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - offset?: number; + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + export interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ + export interface ConditionalStyleData { /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + bottomPadding?: number; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + leftPadding?: number; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - export interface ColorFormatUpdateData { + rightPadding?: number; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: number; + topPadding?: number; + } + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + export interface XmlMappingData { /** - * Specifies the theme color for a color format. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + customXmlPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - export interface ShadowFormatUpdateData { + isMapped?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + prefixMappings?: string; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + xpath?: string; + } + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + export interface CustomXmlPrefixMappingCollectionData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + export interface CustomXmlPrefixMappingData { /** - * Specifies whether the object or the formatting applied to it is visible. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + namespaceUri?: string; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + export interface CustomXmlSchemaData { /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + location?: string; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + export interface CustomXmlSchemaCollectionData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ + export interface CustomXmlValidationErrorCollectionData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + export interface CustomXmlValidationErrorData { /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + node?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the width of the shadow. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + errorCode?: number; /** - * Specifies the type of shadow formatting to apply to a shape. + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + name?: string; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + text?: string; /** - * Specifies the shape shadow type. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; } - /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ - export interface ThreeDimensionalFormatUpdateData { + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + export interface CustomXmlNodeCollectionData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + export interface CustomXmlNodeData { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the depth of the bottom bevel. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: number; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the inset size for the bottom bevel. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the depth of the top bevel. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the inset size for the top bevel. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + previousSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the width of the contour of a shape. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + baseName?: string; /** - * Specifies the depth of the shape's extrusion. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + namespaceUri?: string; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Specifies the amount of perspective for a shape. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + nodeValue?: string; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + text?: string; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + xpath?: string; /** - * Specifies the angle of the lighting. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + export interface ContentControlData { /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Specifies the position of the light source relative to the extrusion. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Specifies the intensity of the extrusion lighting. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Specifies the extrusion surface material. + * Gets the collection of content control objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - rotationX?: number; + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Gets the collection of field objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - rotationY?: number; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the z-axis rotation of the camera. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationZ?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the position on the z-axis for the shape. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - export interface BibliographyUpdateData { + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bibliographyStyle?: string; - } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - export interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; - } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - export interface PageSetupUpdateData { + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * Gets the collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + lists?: Word.Interfaces.ListData[]; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Gets the collection of paragraph objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [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. */ - bookFoldPrinting?: boolean; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies the number of pages for each booklet. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets the collection of table objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bottomMargin?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies the number of characters per line in the document grid. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether the first page has a different header and footer. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - differentFirstPageHeaderFooter?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - footerDistance?: number; + cannotDelete?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutter?: number; + cannotEdit?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + color?: string; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + id?: number; /** - * Specifies the distance between the header and the top of the page in points. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - headerDistance?: number; + placeholderText?: string; /** - * Specifies the layout mode for the current document. + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + removeWhenEdited?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Specifies the style name for the content control. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - leftMargin?: number; + style?: string; /** - * Specifies the number of lines per page in the document grid. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linesPage?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - mirrorMargins?: boolean; + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - oddAndEvenPagesHeaderFooter?: boolean; + tag?: string; /** - * Specifies the orientation of the page. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + text?: string; /** - * Specifies the page height in points. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageHeight?: number; + title?: string; /** - * Specifies the page width in points. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageWidth?: number; + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + } + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + export interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + export interface ContentControlListItemData { /** - * Specifies the paper size of the page. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + displayText?: string; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - rightMargin?: number; + index?: number; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + value?: string; + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + export interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + export interface CustomPropertyData { /** - * Specifies the type of section break for the specified object. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + key?: string; /** - * Specifies whether to show the grid. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showGrid?: boolean; + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - suppressEndnotes?: boolean; + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + export interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + export interface CustomXmlPartData { /** - * Specifies the top margin of the page in points. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin?: number; + documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies whether to print two pages per sheet. + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne?: boolean; + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - export interface LineNumberingUpdateData { + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies the numeric increment for line numbers. + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: number; + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + builtIn?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isActive?: boolean; + id?: string; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + namespaceUri?: string; /** - * Specifies the starting line number. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: number; + xml?: string; } - /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ - export interface TextColumnCollectionUpdateData { - items?: Word.Interfaces.TextColumnData[]; + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + export interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ - export interface TextColumnUpdateData { + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + export interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + export interface DocumentData { /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spaceAfter?: number; + activeWindow?: Word.Interfaces.WindowData; /** - * Specifies the width, in points, of the specified text columns. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ - export interface SelectionUpdateData { + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the ending character position of the selection. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - end?: number; + body?: Word.Interfaces.BodyData; /** - * Specifies the width in which Word fits the text in the current selection. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + coauthoring?: Word.Interfaces.CoauthoringData; /** - * Specifies whether column selection mode is active. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isColumnSelectModeActive?: boolean; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies whether Extend mode is active. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isExtendModeActive?: boolean; + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Specifies whether the beginning of the selection is active. + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive?: boolean; + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Specifies whether Word has detected the language of the selected text. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the orientation of text in the selection. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the starting character position of the selection. + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + listTemplates?: Word.Interfaces.ListTemplateData[]; /** - * Specifies the text in the selection. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; - } - /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ - export interface RangeScopedCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ - export interface BookmarkUpdateData { + pageSetup?: Word.Interfaces.PageSetupData; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + properties?: Word.Interfaces.DocumentPropertiesData; /** - * Specifies the ending character position of the bookmark. + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + selection?: Word.Interfaces.SelectionData; /** - * Specifies the starting character position of the bookmark. + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + windows?: Word.Interfaces.WindowData[]; + /** + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; - } - /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ - export interface BookmarkCollectionUpdateData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ - export interface IndexUpdateData { + activeTheme?: string; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Gets the display name of the active theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + activeThemeDisplayName?: string; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ - export interface IndexCollectionUpdateData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ - export interface ListTemplateCollectionUpdateData { - items?: Word.Interfaces.ListTemplateData[]; - } - /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ - export interface ListTemplateGalleryCollectionUpdateData { - items?: Word.Interfaces.ListTemplateGalleryData[]; - } - /** An interface describing the data returned by calling `editor.toJSON()`. */ - export interface EditorData { + areFilePropertiesPasswordEncrypted?: boolean; /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeData; + areGrammaticalErrorsShown?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Specifies whether to use the default math settings when creating new equations. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + areMathDefaultsUsed?: boolean; /** - * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * Specifies whether to disable features introduced after a specified version. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + areNewerFeaturesDisabled?: boolean; /** - * Gets the name of the editor. + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ - export interface ConflictCollectionData { - items?: Word.Interfaces.ConflictData[]; - } - /** An interface describing the data returned by calling `conflict.toJSON()`. */ - export interface ConflictData { + areSpellingErrorsShown?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + areStylesUpdatedOnOpen?: boolean; /** - * Gets the `RevisionType` for the `Conflict` object. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - export interface CritiqueAnnotationData { + areTrueTypeFontsEmbedded?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - export interface AnnotationData { + autoHyphenation?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + autoSaveOn?: boolean; /** - * Gets the state of the annotation. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.7] - */ - state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; - } - /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ - export interface AnnotationCollectionData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface describing the data returned by calling `application.toJSON()`. */ - export interface ApplicationData { + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Gets the code name for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + codeName?: string; /** - * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; + compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + consecutiveHyphensLimit?: number; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Gets a random number that Word assigns to changes in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - } - /** An interface describing the data returned by calling `body.toJSON()`. */ - export interface BodyData { + currentRsid?: number; /** - * Gets the collection of rich text content control objects in the body. + * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + defaultTabStop?: number; /** - * Gets the collection of field objects in the body. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + defaultTargetFrame?: string; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + doNotEmbedSystemFonts?: boolean; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + encryptionProvider?: string; /** - * Gets the collection of list objects in the body. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lists?: Word.Interfaces.ListData[]; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the collection of paragraph objects in the body. + * Specifies the line break control level. * * @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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * 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 shapes, groups, pictures, and canvases. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + formattingIsNextLevelShown?: boolean; /** - * Gets the collection of table objects in the body. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + formattingIsUserStyleNameShown?: boolean; /** - * 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. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + fullName?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + gridDistanceHorizontal?: number; /** - * Gets the text of the body. Use the insertText method to insert text. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + gridDistanceVertical?: number; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + gridIsOriginFromMargin?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + gridOriginHorizontal?: number; /** - * Gets the location of the border. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + gridOriginVertical?: number; /** - * Specifies the border type for the border. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + gridSpaceBetweenHorizontalLines?: number; /** - * Specifies whether the border is visible. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + gridSpaceBetweenVerticalLines?: number; /** - * Specifies the width for the border. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ - export interface BorderUniversalData { + hasPassword?: boolean; /** - * Specifies the graphical page-border design for the document. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + hasVbProject?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + hyphenateCaps?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the width of the hyphenation zone, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + hyphenationZone?: number; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + isAutoFormatOverrideOn?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + isChartDataPointTracked?: boolean; /** - * Specifies whether the border is visible. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + isCompatible?: boolean; /** - * Specifies the line style of the border. + * Specifies whether the document is final. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + isFinal?: boolean; /** - * Specifies the line width of an object's border. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ - export interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ - export interface BorderUniversalCollectionData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - export interface BreakData { + isFontsSubsetSaved?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isFormsDataPrinted?: boolean; /** - * Returns the page number on which the break occurs. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: number; - } - /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ - export interface BreakCollectionData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ - export interface BuildingBlockData { + isFormsDataSaved?: boolean; /** - * Specifies the description for the building block. + * Specifies whether a grammar check has been run on the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isGrammarChecked?: boolean; /** - * Returns the internal identification number for the building block. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isInAutoSave?: boolean; /** - * Returns the position of this building block in a collection. + * Gets whether the document is in form design mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isInFormsDesign?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + isKerningByAlgorithm?: boolean; /** - * Specifies the name of the building block. + * Specifies whether to embed speech and handwriting data. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + isLinguisticDataEmbedded?: boolean; /** - * Specifies the contents of the building block. + * Gets whether this document is a master document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - export interface BuildingBlockCategoryData { + isMasterDocument?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies whether Word optimizes the document for Word 97. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isOptimizedForWord97?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - export interface BuildingBlockTypeItemData { + isPostScriptPrintedOverText?: boolean; /** - * Returns the position of an item in a collection. + * Specifies whether users can change the Quick Style set. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isQuickStyleSetLocked?: boolean; /** - * Returns the localized name of a building block type. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ - export interface CheckboxContentControlData { + isReadOnly?: boolean; /** - * Specifies the current state of the checkbox. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; - } - /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ - export interface CoauthoringLockData { + isReadOnlyRecommended?: boolean; /** - * Gets the owner of the lock. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorData; + isSnappedToGrid?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isSnappedToShapes?: boolean; /** - * Gets a `CoauthoringLockType` value that represents the lock type. + * Specifies whether spelling has been checked throughout the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; - } - /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ - export interface CoauthoringLockCollectionData { - items?: Word.Interfaces.CoauthoringLockData[]; - } - /** An interface describing the data returned by calling `coauthor.toJSON()`. */ - export interface CoauthorData { + isSpellingChecked?: boolean; /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locks?: Word.Interfaces.CoauthoringLockData[]; + isStyleEnforced?: boolean; /** - * Gets the email address of the coauthor. + * Gets whether this document is a subdocument of a master document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: string; + isSubdocument?: boolean; /** - * Gets the unique identifier for the `Coauthor` object. + * Specifies whether users can change the document theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isThemeLocked?: boolean; /** - * Gets whether this author represents the current user. + * Specifies whether the document was created or opened by the user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + isUserControl?: boolean; /** - * Gets the display name of the coauthor. + * Gets whether the VBA project is digitally signed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ - export interface CoauthorCollectionData { - items?: Word.Interfaces.CoauthorData[]; - } - /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ - export interface CoauthoringData { + isVbaSigned?: boolean; /** - * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * Gets whether the document is protected with a write password. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - authors?: Word.Interfaces.CoauthorData[]; + isWriteReserved?: boolean; /** - * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * Specifies the character spacing adjustment. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflicts?: Word.Interfaces.ConflictData[]; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locks?: Word.Interfaces.CoauthoringLockData[]; + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** - * Gets a `Coauthor` object that represents the current user. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - me?: Word.Interfaces.CoauthorData; + languageDetected?: boolean; /** - * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - updates?: Word.Interfaces.CoauthoringUpdateData[]; + noLineBreakAfter?: string; /** - * Gets whether this document can be coauthored. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canCoauthor?: boolean; + noLineBreakBefore?: string; /** - * Gets whether the document can be automatically merged. + * Gets the encoding used to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canMerge?: boolean; + openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets whether the document has pending updates that have not been accepted. + * Gets the title of the original document after legal-blackline comparison. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pendingUpdates?: boolean; - } - /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ - export interface CoauthoringUpdateData { + originalDocumentTitle?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Sets a password that must be supplied to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; - } - /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ - export interface CoauthoringUpdateCollectionData { - items?: Word.Interfaces.CoauthoringUpdateData[]; - } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - export interface CommentData { + password?: string; /** - * Specifies the comment's content range. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeData; + passwordEncryptionAlgorithm?: string; /** - * Gets the collection of reply objects associated with the comment. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replies?: Word.Interfaces.CommentReplyData[]; + passwordEncryptionKeyLength?: number; /** - * Gets the email of the comment's author. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + passwordEncryptionProvider?: string; /** - * Gets the name of the comment's author. + * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + path?: string; /** - * Specifies the comment's content as plain text. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + printRevisions?: boolean; /** - * Gets the creation date of the comment. + * Gets the protection type for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + protectionType?: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** - * Gets the ID of the comment. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + readingLayoutSizeX?: number; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - export interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - export interface CommentContentRangeData { + readingLayoutSizeY?: number; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + readingModeIsLayoutFrozen?: boolean; /** - * 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. + * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + removePersonalInformationOnSave?: boolean; /** - * Checks whether the range length is zero. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + revisedDocumentTitle?: string; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Gets the file format of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Gets the text of the comment range. + * 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. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - text?: string; + saved?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface describing the data returned by calling `commentReply.toJSON()`. */ - export interface CommentReplyData { - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; - /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the email of the comment reply's author. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** - * Gets the name of the comment reply's author. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + trackFormatting?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + trackMoves?: boolean; /** - * Gets the creation date of the comment reply. + * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + trackRevisions?: boolean; /** - * Gets the ID of the comment reply. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; - } - /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ - export interface CommentReplyCollectionData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ - export interface ConditionalStyleData { + trackedChangesAreDateAndTimeRemoved?: boolean; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * Gets the document type (template or document). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomPadding?: number; + type?: Word.DocumentType | "Document" | "Template" | "Frameset"; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * Sets a password for saving changes to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: number; + writePassword?: string; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightPadding?: number; + xmlAreAdvancedErrorsShown?: boolean; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: number; - } - /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ - export interface XmlMappingData { + xmlIsXsltUsedWhenSaving?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + xmlSaveThroughXSLT?: string; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + export interface DocumentCreatedData { /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + export interface DocumentPropertiesData { /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + applicationName?: string; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: string; + author?: string; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xpath?: string; - } - /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ - export interface CustomXmlPrefixMappingCollectionData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ - export interface CustomXmlPrefixMappingData { + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + creationDate?: Date; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; + keywords?: string; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - export interface CustomXmlSchemaData { + lastAuthor?: string; /** - * Gets the location of the schema on a computer. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - location?: string; + lastPrintDate?: Date; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; - } - /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ - export interface CustomXmlSchemaCollectionData { - items?: Word.Interfaces.CustomXmlSchemaData[]; - } - /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ - export interface CustomXmlValidationErrorCollectionData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; - } - /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ - export interface CustomXmlValidationErrorData { + lastSaveTime?: Date; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - node?: Word.Interfaces.CustomXmlNodeData; + manager?: string; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - errorCode?: number; + revisionNumber?: string; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: string; + security?: number; /** - * Gets the text in the `CustomXmlValidationError` object. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: string; + subject?: string; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the template of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; - } - /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ - export interface CustomXmlNodeCollectionData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ - export interface CustomXmlNodeData { + template?: string; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + export interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + export interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + export interface FieldData { /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + code?: string; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + data?: string; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the field's kind. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + locked?: boolean; /** - * Gets the object representing the part associated with this node. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + showCodes?: boolean; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + } + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + export interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + export interface FontData { /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: string; + fill?: Word.Interfaces.FillFormatData; /** - * Gets the unique address identifier for the namespace of the node. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + glow?: Word.Interfaces.GlowFormatData; /** - * Gets the type of the current node. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + line?: Word.Interfaces.LineFormatData; /** - * Specifies the value of the current node. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; + reflection?: Word.Interfaces.ReflectionFormatData; /** - * Specifies the text for the current node. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + textColor?: Word.Interfaces.ColorFormatData; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: string; + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Gets the XML representation of the current node and its children. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - export interface ContentControlData { + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + allCaps?: boolean; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.1] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + bold?: boolean; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + boldBidirectional?: boolean; /** - * Gets the collection of content control objects in the content control. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] */ - contentControls?: Word.Interfaces.ContentControlData[]; + color?: string; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the collection of field objects in the content control. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + contextualAlternates?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + diacriticColor?: string; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlData; + disableCharacterSpaceGrid?: boolean; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @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[]; + doubleStrikeThrough?: boolean; /** - * Gets the collection of paragraph objects in the content control. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + emboss?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + engrave?: boolean; /** - * Gets the collection of table objects in the content control. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - tables?: Word.Interfaces.TableData[]; + hidden?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + highlightColor?: string; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + italic?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + italicBidirectional?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + kerning?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the ligature setting for the `Font` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Gets an integer that represents the content control identifier. + * Specifies a value that represents the name of the font. * * @remarks * [Api set: WordApi 1.1] */ - id?: number; + name?: string; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + nameAscii?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the font name in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + nameBidirectional?: string; /** - * Specifies the style name for the content control. 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. + * Specifies the East Asian font name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + nameFarEast?: string; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + nameOther?: string; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * Specifies a tag to identify a content control. + * Specifies the number spacing setting for the font. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Gets the text of the content control. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + outline?: boolean; /** - * Specifies the title for a content control. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; + position?: number; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Specifies the scaling percentage applied to the font. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; - } - /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ - export interface ContentControlCollectionData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ - export interface ContentControlListItemData { + scaling?: number; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + shadow?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - index?: number; + size?: number; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the font size in points for right-to-left text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ - export interface ContentControlListItemCollectionData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface describing the data returned by calling `customProperty.toJSON()`. */ - export interface CustomPropertyData { + sizeBidirectional?: number; /** - * Gets the key of the custom property. + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + smallCaps?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the spacing between characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + spacing?: number; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: any; - } - /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ - export interface CustomPropertyCollectionData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ - export interface CustomXmlPartData { + strikeThrough?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + subscript?: boolean; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + superscript?: boolean; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; - /** - * Gets the ID of the custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - id?: string; + underlineColor?: string; + } + /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ + export interface HeadingStyleData { /** - * Gets the namespace URI of the custom XML part. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + level?: number; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the name of style for a heading. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ - export interface CustomXmlPartCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + name?: string; } - /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ - export interface CustomXmlPartScopedCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ + export interface HeadingStyleCollectionData { + items?: Word.Interfaces.HeadingStyleData[]; } - /** An interface describing the data returned by calling `document.toJSON()`. */ - export interface DocumentData { + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { /** - * Gets the active window for the document. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + range?: Word.Interfaces.RangeData; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + address?: string; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + emailSubject?: string; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coauthoring?: Word.Interfaces.CoauthoringData; + isExtraInfoRequired?: boolean; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + name?: string; /** - * Gets the custom XML parts in the document. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + screenTip?: string; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + subAddress?: string; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frames?: Word.Interfaces.FrameData[]; + target?: string; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + textToDisplay?: string; /** - * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplates?: Word.Interfaces.ListTemplateData[]; + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + export interface InlinePictureData { /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageSetup?: Word.Interfaces.PageSetupData; + altTextDescription?: string; /** - * Gets the properties of the document. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - properties?: Word.Interfaces.DocumentPropertiesData; + altTextTitle?: string; /** - * Gets the collection of section objects in the document. + * Specifies a number that describes the height of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - sections?: Word.Interfaces.SectionData[]; + height?: number; /** - * Returns a `Selection` object that represents the current selection in the document. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - selection?: Word.Interfaces.SelectionData; + hyperlink?: string; /** - * Gets the add-in's settings in the document. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - settings?: Word.Interfaces.SettingData[]; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Gets the collection of `Word.Window` objects for the document. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - windows?: Word.Interfaces.WindowData[]; + lockAspectRatio?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoHyphenation?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + export interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ + export interface LinkFormatData { /** - * Specifies if the edits in the document are automatically saved. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + isAutoUpdated?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + isLocked?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + sourceFullName?: string; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + sourceName?: string; /** - * 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. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ - export interface DocumentCreatedData { - /** - * 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.BodyData; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; - /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + sourcePath?: string; /** - * 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. + * Gets the link type. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - export interface DocumentPropertiesData { + /** An interface describing the data returned by calling `list.toJSON()`. */ + export interface ListData { /** - * Gets the collection of custom properties of the document. + * Gets paragraphs in the list. * * @remarks * [Api set: WordApi 1.3] */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the application name of the document. + * Gets the list's id. * * @remarks * [Api set: WordApi 1.3] */ - applicationName?: string; + id?: number; /** - * Specifies the author of the document. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + levelExistences?: boolean[]; /** - * Specifies the category of the document. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks * [Api set: WordApi 1.3] */ - category?: string; + levelTypes?: Word.ListLevelType[]; + } + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + export interface ListCollectionData { + items?: Word.Interfaces.ListData[]; + } + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + export interface ListItemData { /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the level of the item in the list. * * @remarks * [Api set: WordApi 1.3] */ - comments?: string; + level?: number; /** - * Specifies the company of the document. + * Gets the list item bullet, number, or picture as a string. * * @remarks * [Api set: WordApi 1.3] */ - company?: string; + listString?: string; /** - * Gets the creation date of the document. + * Gets the list item order number in relation to its siblings. * * @remarks * [Api set: WordApi 1.3] */ - creationDate?: Date; + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + export interface ListLevelData { /** - * Specifies the format of the document. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - format?: string; + font?: Word.Interfaces.FontData; /** - * Specifies the keywords of the document. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - keywords?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the last author of the document. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastAuthor?: string; + linkedStyle?: string; /** - * Gets the last print date of the document. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastPrintDate?: Date; + numberFormat?: string; /** - * Gets the last save time of the document. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastSaveTime?: Date; + numberPosition?: number; /** - * Specifies the manager of the document. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - manager?: string; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Gets the revision number of the document. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - revisionNumber?: string; + resetOnHigher?: number; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - security?: number; + startAt?: number; /** - * Specifies the subject of the document. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - subject?: string; + tabPosition?: number; /** - * Gets the template of the document. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - template?: string; + textPosition?: number; /** - * Specifies the title of the document. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - title?: string; - } - /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ - export interface DropDownListContentControlData { + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; } - /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ - export interface ComboBoxContentControlData { + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + export interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; } - /** An interface describing the data returned by calling `field.toJSON()`. */ - export interface FieldData { - /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + export interface ListTemplateData { /** - * Specifies the field's code instruction. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApiDesktop 1.1] */ - code?: string; + listLevels?: Word.Interfaces.ListLevelData[]; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - data?: string; + name?: string; /** - * Gets the field's kind. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + outlineNumbered?: boolean; + } + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + export interface NoteItemData { /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * 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] */ - locked?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - showCodes?: boolean; + reference?: Word.Interfaces.RangeData; /** - * Gets the field's type. + * Represents the note item type: footnote or endnote. * * @remarks * [Api set: WordApi 1.5] */ - type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + type?: Word.NoteItemType | "Footnote" | "Endnote"; } - /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ - export interface FieldCollectionData { - items?: Word.Interfaces.FieldData[]; + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + export interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; } - /** An interface describing the data returned by calling `font.toJSON()`. */ - export interface FontData { + /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ + export interface OleFormatData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + classType?: string; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatData; + iconIndex?: number; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatData; + iconLabel?: string; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + iconName?: string; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + iconPath?: string; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatData; + isDisplayedAsIcon?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatData; + isFormattingPreservedOnUpdate?: boolean; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + label?: string; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + progId?: string; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + export interface PageData { /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + breaks?: Word.Interfaces.BreakData[]; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - boldBidirectional?: boolean; + height?: number; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + index?: number; + /** + * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + export interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + export interface PaneData { + /** + * Gets the collection of pages in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pages?: Word.Interfaces.PageData[]; + /** + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pagesEnclosingViewport?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + export interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + export interface WindowData { + /** + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + next?: Word.Interfaces.WindowData; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + previous?: Word.Interfaces.WindowData; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies whether rulers are displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areRulersDisplayed?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + areScreenTipsDisplayed?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + areThumbnailsDisplayed?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + caption?: string; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + height?: number; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + horizontalPercentScrolled?: number; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Gets the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + index?: number; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden?: boolean; + isActive?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + isDocumentMapVisible?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + isRightRulerDisplayed?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + isSplit?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the East Asian font name. + * Specifies whether the window is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + isVisible?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the horizontal position of the window, measured in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + left?: number; /** - * Specifies the number form setting for an OpenType font. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies the number spacing setting for the font. + * Specifies the vertical split percentage for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + splitVertical?: number; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the width of the style area in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + styleAreaWidth?: number; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the vertical position of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + top?: number; /** - * Specifies the scaling percentage applied to the font. + * Gets the window type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + type?: Word.WindowType | "Document" | "Template"; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Gets the height (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + usableHeight?: number; /** - * Specifies a value that represents the font size in points. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size?: number; + usableWidth?: number; /** - * Specifies the font size in points for right-to-left text. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + verticalPercentScrolled?: number; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Specifies the width of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + width?: number; /** - * Specifies the spacing between characters. + * Gets an integer that represents the position of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + windowNumber?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + } + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + export interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface describing the data returned by calling `paragraph.toJSON()`. */ + export interface ParagraphData { /** - * Specifies the stylistic set for the font. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Gets the collection of fields in the paragraph. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - subscript?: boolean; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * 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] */ - superscript?: boolean; + font?: Word.Interfaces.FontData; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - underlineColor?: string; - } - /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ - export interface HeadingStyleData { + listItem?: Word.Interfaces.ListItemData; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - level?: number; + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Specifies the name of style for a heading. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ - export interface HeadingStyleCollectionData { - items?: Word.Interfaces.HeadingStyleData[]; - } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - export interface HyperlinkData { + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - range?: Word.Interfaces.RangeData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - address?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - emailSubject?: string; + firstLineIndent?: number; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isExtraInfoRequired?: boolean; + isLastParagraph?: boolean; /** - * Returns the name of the `Hyperlink` object. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: string; + isListItem?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - screenTip?: string; + leftIndent?: number; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - subAddress?: string; + lineSpacing?: number; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - target?: string; + lineUnitAfter?: number; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - textToDisplay?: string; + lineUnitBefore?: number; /** - * Returns the hyperlink type. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - } - /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ - export interface HyperlinkCollectionData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ - export interface InlinePictureData { + outlineLevel?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the right indent value, in points, for the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - altTextDescription?: string; + rightIndent?: number; /** - * Specifies a string that contains the title for the inline image. + * Specifies the spacing, in points, after the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - altTextTitle?: string; + spaceAfter?: number; /** - * Specifies a number that describes the height of the inline image. + * Specifies the spacing, in points, before the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - height?: number; + spaceBefore?: number; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the style name for the paragraph. 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. * * @remarks * [Api set: WordApi 1.1] */ - hyperlink?: string; + style?: string; /** - * Gets the format of the inline image. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lockAspectRatio?: boolean; + tableNestingLevel?: number; /** - * Specifies a number that describes the width of the inline image. + * Gets the text of the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - export interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ - export interface LinkFormatData { - /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isAutoUpdated?: boolean; + text?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isLocked?: boolean; + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + export interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + export interface ParagraphFormatData { /** - * Specifies if the linked picture is saved with the document. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isPictureSavedWithDocument?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourceFullName?: string; + firstLineIndent?: number; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourceName?: string; + keepTogether?: boolean; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourcePath?: string; + keepWithNext?: boolean; /** - * Gets the link type. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - } - /** An interface describing the data returned by calling `list.toJSON()`. */ - export interface ListData { - /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + leftIndent?: number; /** - * Gets the list's id. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - id?: number; + lineSpacing?: number; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelExistences?: boolean[]; + lineUnitAfter?: number; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelTypes?: Word.ListLevelType[]; - } - /** An interface describing the data returned by calling `listCollection.toJSON()`. */ - export interface ListCollectionData { - items?: Word.Interfaces.ListData[]; - } - /** An interface describing the data returned by calling `listItem.toJSON()`. */ - export interface ListItemData { + lineUnitBefore?: number; /** - * Specifies the level of the item in the list. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - level?: number; + mirrorIndents?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listString?: string; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Gets the list item order number in relation to its siblings. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - export interface ListLevelData { + rightIndent?: number; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontData; + spaceAfter?: number; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + spaceBefore?: number; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - linkedStyle?: string; + widowControl?: boolean; + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + export interface RangeData { /** - * Specifies the number format for the specified list level. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies the number style for the list level object. + * Gets the collection of field objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - resetOnHigher?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the starting number for the specified list level object. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the tab position for the specified list level object. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.2] */ - textPosition?: number; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the character inserted after the number for the specified list level. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ - export interface ListLevelCollectionData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ - export interface ListTemplateData { + listFormat?: Word.Interfaces.ListFormatData; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Gets the collection of pages in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - listLevels?: Word.Interfaces.ListLevelData[]; + pages?: Word.Interfaces.PageData[]; /** - * Specifies the name of the list template. + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + sections?: Word.Interfaces.SectionData[]; /** - * Specifies whether the list template is outline numbered. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - export interface NoteItemData { + shading?: Word.Interfaces.ShadingUniversalData; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Represents a footnote or endnote reference in the main document. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Represents the note item type: footnote or endnote. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; - } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - export interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ - export interface OleFormatData { + bold?: boolean; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + boldBidirectional?: boolean; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex?: number; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel?: string; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: string; + combineCharacters?: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconPath?: string; + disableCharacterSpaceGrid?: boolean; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDisplayedAsIcon?: boolean; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate?: boolean; + end?: number; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - label?: string; + fitTextWidth?: number; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - progID?: string; - } - /** An interface describing the data returned by calling `page.toJSON()`. */ - export interface PageData { + grammarChecked?: boolean; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - breaks?: Word.Interfaces.BreakData[]; + hasNoProofing?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * 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. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - width?: number; - } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - export interface PageCollectionData { - items?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - export interface PaneData { + hyperlink?: string; /** - * Gets the collection of pages in the pane. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + id?: string; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pagesEnclosingViewport?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ - export interface PaneCollectionData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface describing the data returned by calling `window.toJSON()`. */ - export interface WindowData { + isEmpty?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.WindowData; + isEndOfRowMark?: boolean; /** - * Gets the previous document window in the collection open document windows. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.WindowData; + isTextVisibleOnScreen?: boolean; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies if the font or range is formatted as italic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + italic?: boolean; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areScreenTipsDisplayed?: boolean; + italicBidirectional?: boolean; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areThumbnailsDisplayed?: boolean; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caption?: string; + languageDetected?: boolean; /** - * Specifies the height of the window (in points). + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPercentScrolled?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the position of an item in a collection. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + showAll?: boolean; /** - * Specifies whether the window is active. + * Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + spellingChecked?: boolean; /** - * Specifies whether the document map is visible. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDocumentMapVisible?: boolean; + start?: number; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEnvelopeVisible?: boolean; + storyLength?: number; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHorizontalScrollBarDisplayed?: boolean; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the style name for the range. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isLeftScrollBarDisplayed?: boolean; + style?: string; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isRightRulerDisplayed?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies whether the window is split into multiple panes. + * Gets the text of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isSplit?: boolean; + text?: string; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalRulerDisplayed?: boolean; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed?: boolean; + underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + export interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + export interface SearchOptionsData { /** - * Specifies whether the window is visible. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + ignorePunct?: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - left?: number; + ignoreSpace?: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + matchCase?: boolean; /** - * Specifies the vertical split percentage for the window. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - splitVertical?: number; + matchPrefix?: boolean; /** - * Specifies the width of the style area in points. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - styleAreaWidth?: number; + matchSuffix?: boolean; /** - * Specifies the vertical position of the document window, in points. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - top?: number; + matchWholeWord?: boolean; /** - * Gets the window type. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.WindowType | "Document" | "Template"; + matchWildcards?: boolean; + } + /** An interface describing the data returned by calling `section.toJSON()`. */ + export interface SectionData { /** - * Gets the height (in points) of the active working area in the document window. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableHeight?: number; + body?: Word.Interfaces.BodyData; /** - * Gets the width (in points) of the active working area in the document window. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: number; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies the width of the document window, in points. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + protectedForForms?: boolean; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + export interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + export interface SettingData { /** - * Gets an integer that represents the position of the window. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - windowNumber?: number; + key?: string; /** - * Specifies the state of the document window or task window. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + value?: any; } - /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ - export interface WindowCollectionData { - items?: Word.Interfaces.WindowData[]; + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + export interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; } - /** An interface describing the data returned by calling `paragraph.toJSON()`. */ - export interface ParagraphData { + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + export interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + export interface StyleData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * 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] + */ + font?: Word.Interfaces.FontData; + /** + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + frame?: Word.Interfaces.FrameData; /** - * Gets the collection of fields in the paragraph. + * Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + linkStyle?: Word.Interfaces.StyleData; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - font?: Word.Interfaces.FontData; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listItem?: Word.Interfaces.ListItemData; + shading?: Word.Interfaces.ShadingData; /** - * 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}. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + automaticallyUpdate?: boolean; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shapes?: Word.Interfaces.ShapeData[]; - /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApi 1.1] + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + baseStyle?: string; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - firstLineIndent?: number; + builtIn?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Gets the description of the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + description?: string; /** - * Checks whether the paragraph is a list item. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + hasProofing?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - leftIndent?: number; + inUse?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - lineUnitBefore?: number; + linked?: boolean; /** - * Specifies the outline level for the paragraph. + * Returns the list level for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + listLevelNumber?: number; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + locked?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - spaceAfter?: number; + nameLocal?: string; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - spaceBefore?: number; + nextParagraphStyle?: string; /** - * Specifies the style name for the paragraph. 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. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + priority?: number; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - tableNestingLevel?: number; + quickStyle?: boolean; /** - * Gets the text of the paragraph. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: string; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - export interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - export interface ParagraphFormatData { + unhideWhenUsed?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + export interface ShadingData { /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - firstLineIndent?: number; + backgroundPatternColor?: string; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - keepTogether?: boolean; + foregroundPatternColor?: string; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - keepWithNext?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + export interface ShadingUniversalData { /** - * Specifies the left indent. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + backgroundPatternColor?: string; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + foregroundPatternColor?: string; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether left and right indents are the same width. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + export interface TableData { /** - * Specifies the outline level for the specified paragraphs. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceAfter?: number; + rows?: Word.Interfaces.TableRowData[]; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceBefore?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - export interface RangeData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + description?: string; /** - * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - conflicts?: Word.Interfaces.ConflictData[]; + headerRowCount?: number; /** - * Gets the collection of field objects in the range. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + isUniform?: boolean; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frames?: Word.Interfaces.FrameData[]; + nestingLevel?: number; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + rowCount?: number; /** - * Gets the collection of inline picture objects in the range. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + shadingColor?: string; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the style name for the table. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listFormat?: Word.Interfaces.ListFormatData; + style?: string; /** - * Gets the collection of pages in the range. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + styleBandedColumns?: boolean; /** - * Gets the collection of sections in the range. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + styleBandedRows?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalData; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + styleFirstColumn?: boolean; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tableColumns?: Word.Interfaces.TableColumnData[]; + styleLastColumn?: boolean; /** - * Specifies whether the range is formatted as bold. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bold?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + title?: string; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + values?: string[][]; /** - * Specifies the character width of the range. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies if the range contains combined characters. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - combineCharacters?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + export interface TableStyleData { /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - disableCharacterSpaceGrid?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the emphasis mark for a character or designated character string. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + allowBreakAcrossPage?: boolean; /** - * Specifies the ending character position of the range. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - end?: number; + bottomCellMargin?: number; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - fitTextWidth?: number; + cellSpacing?: number; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + columnStripe?: number; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies the highlight color for the range. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + leftCellMargin?: number; /** - * Specifies the formatting for horizontal text set within vertical text. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + leftIndent?: number; /** - * 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. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + rightCellMargin?: number; /** - * Specifies the ID for the range. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + rowStripe?: number; /** - * Checks whether the range length is zero. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isEndOfRowMark?: boolean; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + export interface TabStopData { /** - * Gets whether the text in the range is visible on the screen. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTextVisibleOnScreen?: boolean; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies if the font or range is formatted as italic. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + customTab?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + position?: number; + } + /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ + export interface TabStopCollectionData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + export interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + export interface TableColumnData { /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies an East Asian language for the range. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + columnIndex?: number; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isFirst?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + isLast?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + nestingLevel?: number; /** - * Specifies the starting character position of the range. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + preferredWidth?: number; /** - * Gets the number of characters in the story that contains the range. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Gets the story type for the range. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + width?: number; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + export interface TableColumnCollectionData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ + export interface TableOfAuthoritiesData { /** - * Specifies the style name for the range. 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. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + bookmark?: string; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + category?: number; /** - * Gets the text of the range. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + entrySeparator?: string; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + isCategoryHeaderIncluded?: boolean; /** - * Specifies the type of underline applied to the range. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - export interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - export interface SearchOptionsData { + isEntryFormattingKept?: boolean; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + isPassimUsed?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + pageNumberSeparator?: string; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + pageRangeSeparator?: string; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + sequenceName?: string; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + sequenceSeparator?: string; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ + export interface TableOfAuthoritiesCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ + export interface TableOfAuthoritiesCategoryData { /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; + name?: string; } - /** An interface describing the data returned by calling `section.toJSON()`. */ - export interface SectionData { + /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ + export interface TableOfAuthoritiesCategoryCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ + export interface TableOfContentsData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + areBuiltInHeadingStylesUsed?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + areFieldsUsed?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupData; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - export interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - export interface SettingData { + arePageNumbersHiddenOnWeb?: boolean; /** - * Gets the key of the setting. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + arePageNumbersIncluded?: boolean; /** - * Specifies the value of the setting. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ - export interface SettingCollectionData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ - export interface StyleCollectionData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface describing the data returned by calling `style.toJSON()`. */ - export interface StyleData { + arePageNumbersRightAligned?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderData[]; + lowerHeadingLevel?: number; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameData; + tableId?: string; /** - * Specifies a link between a paragraph and a character style. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleData; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ + export interface TableOfContentsCollectionData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ + export interface TableOfFiguresData { /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + areBuiltInHeadingStylesUsed?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + areFieldsUsed?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingData; + areHyperlinksUsedOnWeb?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleData; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + arePageNumbersRightAligned?: boolean; /** - * Gets whether the specified style is a built-in style. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + captionLabel?: string; /** - * Gets the description of the specified style. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isLabelIncluded?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + lowerHeadingLevel?: number; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + tableId?: string; /** - * Specifies an East Asian language for the style. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ + export interface TableOfFiguresCollectionData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + export interface TableRowData { /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cells?: Word.Interfaces.TableCellData[]; + /** + * Gets the collection of field objects in the table row. + * + * @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] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - linked?: boolean; + cellCount?: number; /** - * Returns the list level for the style. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listLevelNumber?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the style cannot be changed or edited. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - locked?: boolean; + isHeader?: boolean; /** - * Gets the name of a style in the language of the user. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nameLocal?: string; + preferredHeight?: number; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - nextParagraphStyle?: string; + rowIndex?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + shadingColor?: string; /** - * Specifies the priority. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - priority?: number; + values?: string[][]; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quickStyle?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + export interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + export interface TableCellData { /** - * Gets the style type. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + body?: Word.Interfaces.BodyData; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - unhideWhenUsed?: boolean; + cellIndex?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - export interface ShadingData { + columnWidth?: number; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: string; + rowIndex?: number; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - export interface ShadingUniversalData { + shadingColor?: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: string; + value?: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: string; + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + export interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + export interface TableBorderData { /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + color?: string; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `table.toJSON()`. */ - export interface TableData { + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Gets the collection of field objects in the table. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + width?: number; + } + /** An interface describing the data returned by calling `template.toJSON()`. */ + export interface TemplateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets all of the table rows. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rows?: Word.Interfaces.TableRowData[]; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the child tables nested one level deeper. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + fullName?: string; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + hasNoProofing?: boolean; /** - * Specifies the description of the table. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies the number of header rows. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + kerningByAlgorithm?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Indicates whether all of the table rows are uniform. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isUniform?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: number; + name?: string; /** - * Gets the number of rows in the table. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: number; + noLineBreakAfter?: string; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + noLineBreakBefore?: string; /** - * Specifies the style name for the table. 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. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + path?: string; /** - * Specifies whether the table has banded columns. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + saved?: boolean; /** - * Specifies whether the table has banded rows. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; + } + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + export interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + export interface TrackedChangeData { /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + author?: string; /** - * Specifies whether the table has a first column with a special style. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleFirstColumn?: boolean; + date?: Date; /** - * Specifies whether the table has a last column with a special style. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleLastColumn?: boolean; + text?: string; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleTotalRow?: boolean; + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + export interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `view.toJSON()`. */ + export interface ViewData { /** - * Specifies the title of the table. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + areBackgroundsDisplayed?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + areBookmarksIndicated?: boolean; /** - * Specifies the width of the table in points. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - export interface TableStyleData { + areCommentsDisplayed?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + areCropMarksDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + areDrawingsDisplayed?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + areEditableRangesShaded?: boolean; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnStripe?: number; + areFieldCodesDisplayed?: boolean; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isBreakAcrossPagesAllowed?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftIndent?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + areLinesWrappedToWindow?: boolean; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe?: number; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface describing the data returned by calling `tabStop.toJSON()`. */ - export interface TabStopData { + areOptionalHyphensDisplayed?: boolean; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Gets whether other authors' presence should be visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + areOtherAuthorsVisible?: boolean; /** - * Gets whether this tab stop is a custom tab stop. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + arePageBoundariesDisplayed?: boolean; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * Gets whether paragraph marks are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + areParagraphsMarksDisplayed?: boolean; /** - * Gets the position of the tab stop relative to the left margin. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; - } - /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ - export interface TabStopCollectionData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - export interface TableCollectionData { - items?: Word.Interfaces.TableData[]; - } - /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ - export interface TableColumnData { + arePicturePlaceholdersDisplayed?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets whether space characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + areSpacesIndicated?: boolean; /** - * Returns the position of this column in a collection. + * Specifies whether table gridlines are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: number; + areTableGridlinesDisplayed?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Gets whether tab characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areTabsDisplayed?: boolean; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areTextBoundariesDisplayed?: boolean; /** - * Returns the nesting level of the column. + * Specifies the column width in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: number; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets on-screen shading for fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + isDraft?: boolean; /** - * Specifies the width of the column, in points. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ - export interface TableColumnCollectionData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ - export interface TableOfAuthoritiesData { + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark?: string; + isFormatDisplayed?: boolean; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies whether the window is in full-screen view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: number; + isFullScreen?: boolean; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * Gets whether text formatted as hidden text is displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entrySeparator?: string; + isHiddenTextDisplayed?: boolean; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCategoryHeaderIncluded?: boolean; + isHighlightingDisplayed?: boolean; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Specifies whether the document is in conflict mode view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEntryFormattingKept?: boolean; + isInConflictMode?: boolean; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPassimUsed?: boolean; + isInPanning?: boolean; /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator?: string; + isInReadingLayout?: boolean; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator?: string; + isMailMergeDataView?: boolean; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName?: string; + isMainTextLayerVisible?: boolean; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator?: string; + isPointerShownAsMagnifier?: boolean; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ - export interface TableOfAuthoritiesCollectionData { - items?: Word.Interfaces.TableOfAuthoritiesData[]; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ - export interface TableOfAuthoritiesCategoryData { + isReadingLayoutActualView?: boolean; /** - * Specifies the name of this table of authorities category. - Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ - export interface TableOfAuthoritiesCategoryCollectionData { - items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; - } - /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ - export interface TableOfContentsData { + isXmlMarkupVisible?: boolean; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies whether page numbers are included in the table of contents. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + revisionsBalloonWidth?: number; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the character between entries and their page numbers in the table of contents. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ - export interface TableOfContentsCollectionData { - items?: Word.Interfaces.TableOfContentsData[]; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } - /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ - export interface TableOfFiguresData { + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { /** - * Specifies whether built-in heading styles are used for the table of figures. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areBuiltInHeadingStylesUsed?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 + * [Api set: WordApiDesktop 1.2] */ - areFieldsUsed?: boolean; + canvas?: Word.Interfaces.CanvasData; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areHyperlinksUsedOnWeb?: boolean; + fill?: Word.Interfaces.ShapeFillData; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersHiddenOnWeb?: boolean; + parentCanvas?: Word.Interfaces.ShapeData; /** - * Specifies whether page numbers are included in the table of figures. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersIncluded?: boolean; + parentGroup?: Word.Interfaces.ShapeData; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersRightAligned?: boolean; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Specifies the label that identifies the items to be included in the table of figures. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - captionLabel?: string; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isLabelIncluded?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lowerHeadingLevel?: number; + allowOverlap?: boolean; /** - * Specifies the character between entries and their page numbers in the table of figures. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + altTextDescription?: string; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tableId?: string; + geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - upperHeadingLevel?: number; - } - /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ - export interface TableOfFiguresCollectionData { - items?: Word.Interfaces.TableOfFiguresData[]; - } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - export interface TableRowData { + height?: number; /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; /** - * Gets the collection of field objects in the table row. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; /** - * 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; + * Check whether this shape is a child of a group shape or a canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + isChild?: boolean; /** - * Gets the number of cells in the row. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - cellCount?: number; + left?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + leftRelative?: number; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isHeader?: boolean; + lockAspectRatio?: boolean; /** - * Specifies the preferred height of the row in points. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - preferredHeight?: number; + name?: string; /** - * Gets the index of the row in its parent table. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowIndex?: number; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: string[][]; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ - export interface TableRowCollectionData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface describing the data returned by calling `tableCell.toJSON()`. */ - export interface TableCellData { + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the body object of the cell. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyData; + rotation?: number; /** - * Gets the index of the cell in its row. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - cellIndex?: number; + top?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - columnWidth?: number; + topRelative?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Gets the index of the cell's row in the table. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowIndex?: number; + visible?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + width?: number; /** - * Specifies the text of the cell. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - value?: string; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + export interface ShapeGroupData { /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + shape?: Word.Interfaces.ShapeData; /** - * Gets the width of the cell in points. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; - } - /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ - export interface TableCellCollectionData { - items?: Word.Interfaces.TableCellData[]; + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the shape group identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; } - /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ - export interface TableBorderData { + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + export interface CanvasData { /** - * Specifies the table border color. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + shape?: Word.Interfaces.ShapeData; /** - * Specifies the type of the table border. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the canvas identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + export interface ShapeFillData { + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + backgroundColor?: string; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; - } - /** An interface describing the data returned by calling `template.toJSON()`. */ - export interface TemplateData { + foregroundColor?: string; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + transparency?: number; /** - * Specifies the line break control level for the document. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + export interface TextFrameData { /** - * Returns the name of the template, including the drive or Web path. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fullName?: string; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasNoProofing?: boolean; + bottomMargin?: number; /** - * Specifies the character spacing adjustment for the template. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + hasText?: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kerningByAlgorithm?: boolean; + leftMargin?: number; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + noTextRotation?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Returns only the name of the document template (excluding any path or other location information). + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - name?: string; + rightMargin?: number; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noLineBreakAfter?: string; + topMargin?: number; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noLineBreakBefore?: string; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Returns the path to the document template. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - path?: string; + wordWrap?: boolean; + } + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + export interface ShapeTextWrapData { /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - saved?: boolean; + bottomDistance?: number; /** - * Returns the template type. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - type?: Word.TemplateType | "Normal" | "Global" | "Attached"; - } - /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ - export interface TemplateCollectionData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - export interface TrackedChangeData { + leftDistance?: number; /** - * Gets the author of the tracked change. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - author?: string; + rightDistance?: number; /** - * Gets the date of the tracked change. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - date?: Date; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Gets the text of the tracked change. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - text?: string; + topDistance?: number; /** - * Gets the type of the tracked change. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; - } - /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ - export interface TrackedChangeCollectionData { - items?: Word.Interfaces.TrackedChangeData[]; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; } - /** An interface describing the data returned by calling `view.toJSON()`. */ - export interface ViewData { + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + export interface ReviewerData { /** - * Specifies whether all nonprinting characters are displayed. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + isVisible?: boolean; + } + /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ + export interface ReviewerCollectionData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ + export interface RevisionsFilterData { /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBookmarksIndicated?: boolean; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + export interface RepeatingSectionItemData { /** - * Specifies whether Microsoft Word displays the comments in the document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `revision.toJSON()`. */ + export interface RevisionData { /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + movedRange?: Word.Interfaces.RangeData; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCropMarksDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areDrawingsDisplayed?: boolean; + author?: string; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Gets the date and time when the tracked change was made. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + date?: Date; /** - * Specifies whether field codes are displayed. + * Gets the description of tracked formatting changes in the revision. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + formatDescription?: string; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Gets a number that represents the position of this item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + index?: number; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Gets the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ + export interface RevisionCollectionData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + export interface DatePickerContentControlData { /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areLinesWrappedToWindow?: boolean; + range?: Word.Interfaces.RangeData; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areObjectAnchorsDisplayed?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether Microsoft Word displays optional line breaks. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalBreaksDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether optional hyphens are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalHyphensDisplayed?: boolean; + color?: string; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageBoundariesDisplayed?: boolean; + dateDisplayFormat?: string; /** - * Gets whether paragraph marks are displayed. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areParagraphsMarksDisplayed?: boolean; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePicturePlaceholdersDisplayed?: boolean; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + id?: string; /** - * Gets whether space characters are displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areSpacesIndicated?: boolean; + isTemporary?: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets whether tab characters are displayed. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTabsDisplayed?: boolean; + lockContentControl?: boolean; /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTextBoundariesDisplayed?: boolean; + lockContents?: boolean; /** - * Specifies the column width in Reading mode. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + showingPlaceholderText?: boolean; /** - * Gets on-screen shading for fields. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + tag?: string; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + export interface PictureContentControlData { /** - * Specifies whether only the first line of body text is shown in outline view. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies whether character formatting is visible in outline view. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies whether the window is in full-screen view. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether text formatted as hidden text is displayed. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHiddenTextDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHighlightingDisplayed?: boolean; + color?: string; /** - * Specifies whether the document is in conflict mode view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + id?: string; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + isTemporary?: boolean; /** - * Specifies whether the document is being viewed in reading layout view. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + lockContentControl?: boolean; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + lockContents?: boolean; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + tag?: string; /** - * Specifies whether XML tags are visible in the document. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + export interface GroupContentControlData { /** - * Specifies the display mode for tracked changes. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the page color in Reading mode. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + range?: Word.Interfaces.RangeData; /** - * Specifies the page movement type. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; + color?: string; /** - * Specifies the width of the revision balloons. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + id?: string; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + isTemporary?: boolean; /** - * Specifies the document element displayed in print layout view. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the active window pane. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + lockContentControl?: boolean; /** - * Specifies the view type. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface describing the data returned by calling `shape.toJSON()`. */ - export interface ShapeData { - /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - body?: Word.Interfaces.BodyData; + lockContents?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasData; + showingPlaceholderText?: boolean; /** - * Returns the fill formatting of the shape. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillData; + tag?: string; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeData; + title?: string; + } + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + export interface BuildingBlockGalleryContentControlData { /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + range?: Word.Interfaces.RangeData; /** - * Gets the text frame object of the shape. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Returns the text wrap formatting of the shape. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + buildingBlockCategory?: string; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + color?: string; /** - * The height, in points, of the shape. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + id?: string; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + isTemporary?: boolean; /** - * Gets an integer that represents the shape identifier. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: boolean; + lockContentControl?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + lockContents?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets if the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + showingPlaceholderText?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + tag?: string; /** - * The name of the shape. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + title?: string; + } + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + export interface RepeatingSectionContentControlData { /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + range?: Word.Interfaces.RangeData; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + xmlapping?: Word.Interfaces.XmlMappingData; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + allowInsertDeleteSection?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + color?: string; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + id?: string; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + isTemporary?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The width, in points, of the shape. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + lockContentControl?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - export interface ShapeGroupData { + lockContents?: boolean; /** - * Gets the Shape object associated with the group. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + repeatingSectionItemTitle?: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + showingPlaceholderText?: boolean; /** - * Gets an integer that represents the shape group identifier. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - export interface CanvasData { + tag?: string; /** - * Gets the Shape object associated with the canvas. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + title?: string; + } + /** An interface describing the data returned by calling `readabilityStatistic.toJSON()`. */ + export interface ReadabilityStatisticData { /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + name?: string; /** - * Gets an integer that represents the canvas identifier. + * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + value?: number; } - /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ - export interface ShapeCollectionData { - items?: Word.Interfaces.ShapeData[]; + /** An interface describing the data returned by calling `readabilityStatisticCollection.toJSON()`. */ + export interface ReadabilityStatisticCollectionData { + items?: Word.Interfaces.ReadabilityStatisticData[]; } - /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ - export interface ShapeFillData { + /** An interface describing the data returned by calling `webSettings.toJSON()`. */ + export interface WebSettingsData { /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + allowPng?: boolean; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + folderSuffix?: string; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; - } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - export interface TextFrameData { + organizeInFolder?: boolean; /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + pixelsPerInch?: number; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + relyOnCSS?: boolean; /** - * Specifies if the text frame contains text. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + useLongFileNames?: boolean; + } + /** An interface describing the data returned by calling `xmlNodeCollection.toJSON()`. */ + export interface XmlNodeCollectionData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface describing the data returned by calling `xmlNode.toJSON()`. */ + export interface XmlNodeData { /** - * Represents the right margin, in points, of the text frame. + * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + baseName?: string; /** - * Represents the top margin, in points, of the text frame. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + hasChildNodes?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + level?: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - export interface ShapeTextWrapData { + namespaceUri?: string; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the type of node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + nodeType?: Word.XmlNodeType | "Element" | "Attribute"; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + nodeValue?: string; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + placeholderText?: string; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + text?: string; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + validationErrorText?: string; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom"; } - /** An interface describing the data returned by calling `reviewer.toJSON()`. */ - export interface ReviewerData { + /** An interface describing the data returned by calling `htmlDivision.toJSON()`. */ + export interface HtmlDivisionData { /** - * Specifies if the `Reviewer` object is visible. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ - export interface ReviewerCollectionData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ - export interface RevisionsFilterData { + leftIndent?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + rightIndent?: number; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ - export interface RepeatingSectionItemData { + spaceAfter?: number; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + spaceBefore?: number; } - /** An interface describing the data returned by calling `revision.toJSON()`. */ - export interface RevisionData { + /** An interface describing the data returned by calling `htmlDivisionCollection.toJSON()`. */ + export interface HtmlDivisionCollectionData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + export interface FrameData { /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedRange?: Word.Interfaces.RangeData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -57768,2347 +65865,2473 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeData; /** - * Gets the name of the user who made the tracked change. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - author?: string; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the date and time when the tracked change was made. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - date?: Date; + height?: number; /** - * Gets the description of tracked formatting changes in the revision. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatDescription?: string; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Gets a number that represents the position of this item in a collection. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + horizontalDistanceFromText?: number; /** - * Gets the revision type. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; - } - /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ - export interface RevisionCollectionData { - items?: Word.Interfaces.RevisionData[]; - } - /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ - export interface DatePickerContentControlData { + horizontalPosition?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + lockAnchor?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the appearance of the content control. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + textWrap?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + verticalDistanceFromText?: number; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + verticalPosition?: number; /** - * Specifies the format in which dates are displayed. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + width?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ + export interface FrameCollectionData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ + export interface DocumentLibraryVersionData { /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Gets any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + comments?: string; /** - * Gets the identification for the content control. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + modified?: any; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + modifiedBy?: string; + } + /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ + export interface DocumentLibraryVersionCollectionData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface describing the data returned by calling `dropCap.toJSON()`. */ + export interface DropCapData { /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + distanceFromText?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the name of the font for the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + fontName?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the height (in lines) of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + linesToDrop?: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Gets the position of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; + } + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + export interface ListFormatData { /** - * Specifies a tag to identify the content control. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + list?: Word.Interfaces.ListData; /** - * Specifies the title for the content control. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ - export interface PictureContentControlData { + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isSingleList?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isSingleListTemplate?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + listLevelNumber?: number; /** - * Specifies the appearance of the content control. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + listString?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Returns the identification for the content control. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + export interface FillFormatData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + gradientAngle?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + gradientDegree?: number; /** - * Specifies a tag to identify the content control. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies the title for the content control. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ - export interface GroupContentControlData { + gradientVariant?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isVisible?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Specifies the appearance of the content control. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + rotateWithObject?: boolean; /** - * Returns the identification for the content control. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + textureHorizontalScale?: number; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + textureName?: string; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + textureOffsetX?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + textureOffsetY?: number; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + textureTile?: boolean; /** - * Specifies a tag to identify the content control. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies the title for the content control. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ - export interface BuildingBlockGalleryContentControlData { + textureVerticalScale?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + transparency?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the fill format type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + } + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + export interface GlowFormatData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + color?: Word.Interfaces.ColorFormatData; /** - * Specifies the appearance of the content control. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + radius?: number; /** - * Specifies the category for the building block content control. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + export interface LineFormatData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets the identification for the content control. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies a tag to identify the content control. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the title for the content control. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ - export interface RepeatingSectionContentControlData { + insetPen?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isVisible?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingData; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + transparency?: number; /** - * Specifies the appearance of the content control. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + export interface ReflectionFormatData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + blur?: number; /** - * Returns the identification for the content control. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + offset?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + size?: number; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + transparency?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ + export interface ColorFormatData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + brightness?: number; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rgb?: string; /** - * Specifies a tag to identify the content control. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + tintAndShade?: number; /** - * Specifies the title for the content control. + * Returns the shape color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + type?: Word.ColorType | "rgb" | "scheme"; } - /** An interface describing the data returned by calling `frame.toJSON()`. */ - export interface FrameData { + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + export interface ShadowFormatData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + blur?: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + isVisible?: boolean; /** - * Specifies the height (in points) of the frame. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + obscured?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + offsetX?: number; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + offsetY?: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + rotateWithShape?: boolean; /** - * Specifies if the frame is locked. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + size?: number; /** - * Specifies the relative horizontal position of the frame. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies the relative vertical position of the frame. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + transparency?: number; /** - * Specifies if document text wraps around the frame. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ + export interface ThreeDimensionalFormatData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the width (in points) of the frame. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + bevelBottomDepth?: number; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ - export interface FrameCollectionData { - items?: Word.Interfaces.FrameData[]; - } - /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ - export interface DocumentLibraryVersionData { + bevelBottomInset?: number; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: string; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: any; + bevelTopDepth?: number; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: string; - } - /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ - export interface DocumentLibraryVersionCollectionData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface describing the data returned by calling `dropCap.toJSON()`. */ - export interface DropCapData { + bevelTopInset?: number; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Gets the name of the font for the dropped capital letter. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: string; + contourWidth?: number; /** - * Gets the height (in lines) of the dropped capital letter. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: number; + depth?: number; /** - * Gets the position of the dropped capital letter. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: Word.DropPosition | "None" | "Normal" | "Margin"; - } - /** An interface describing the data returned by calling `listFormat.toJSON()`. */ - export interface ListFormatData { + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list?: Word.Interfaces.ListData; + fieldOfView?: number; /** - * Gets the list template associated with the `ListFormat` object. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isPerspective?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + isVisible?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + lightAngle?: number; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - export interface FillFormatData { + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Gets the gradient color type. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + projectText?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: number; + rotationX?: number; /** - * Returns the gradient style for the fill. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + rotationY?: number; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: number; + rotationZ?: number; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + export interface BibliographyData { /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + sources?: Word.Interfaces.SourceData[]; /** - * Returns the preset gradient type for the fill. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + bibliographyStyle?: string; + } + /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ + export interface SourceCollectionData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface describing the data returned by calling `source.toJSON()`. */ + export interface SourceData { /** - * Gets the preset texture. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + isCited?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + tag?: string; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + export interface PageSetupData { /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Returns the name of the custom texture file for the fill. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: string; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + bookFoldPrinting?: boolean; /** - * Specifies the vertical offset of the texture. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + bookFoldPrintingSheets?: number; /** - * Specifies whether the texture is tiled. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + bookFoldReversePrinting?: boolean; /** - * Returns the texture type for the fill. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + bottomMargin?: number; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + charsLine?: number; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + differentFirstPageHeaderFooter?: boolean; /** - * Gets the fill format type. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - export interface GlowFormatData { + footerDistance?: number; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatData; + gutter?: number; /** - * Specifies the length of the radius for a glow effect. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - export interface LineFormatData { + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + headerDistance?: number; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + leftMargin?: number; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + linesPage?: number; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + mirrorMargins?: boolean; /** - * Specifies the dash style for the line. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + pageHeight?: number; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + pageWidth?: number; /** - * Specifies if to draw lines inside a shape. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + rightMargin?: number; /** - * Specifies the pattern applied to the line. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the line format style. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + showGrid?: boolean; /** - * Specifies the thickness of the line in points. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; - } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - export interface ReflectionFormatData { + suppressEndnotes?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + topMargin?: number; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + twoPagesOnOne?: boolean; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + export interface LineNumberingData { /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + countBy?: number; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ - export interface ColorFormatData { + distanceFromText?: number; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: number; + isActive?: boolean; /** - * Specifies the theme color for a color format. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + startingNumber?: number; + } + /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ + export interface TextColumnCollectionData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface describing the data returned by calling `textColumn.toJSON()`. */ + export interface TextColumnData { /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: number; + spaceAfter?: number; /** - * Returns the shape color type. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ColorType | "rgb" | "scheme"; + width?: number; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - export interface ShadowFormatData { + /** An interface describing the data returned by calling `selection.toJSON()`. */ + export interface SelectionData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + end?: number; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + fitTextWidth?: number; /** - * Specifies whether the object or the formatting applied to it is visible. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + hasNoProofing?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + isActive?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + isColumnSelectModeActive?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + isEndOfRowMark?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + isExtendModeActive?: boolean; /** - * Specifies the width of the shadow. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + isInsertionPointAtEndOfLine?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + isStartActive?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + languageDetected?: boolean; /** - * Specifies the shape shadow type. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ - export interface ThreeDimensionalFormatData { + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatData; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the depth of the bottom bevel. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: number; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the inset size for the bottom bevel. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + start?: number; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Returns the number of characters in the story that contains the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + storyLength?: number; /** - * Specifies the depth of the top bevel. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the inset size for the top bevel. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + text?: string; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + } + /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ + export interface RangeScopedCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + export interface BookmarkData { /** - * Specifies the width of the contour of a shape. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies the depth of the shape's extrusion. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + end?: number; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Returns `true` if the bookmark is a table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + isColumn?: boolean; /** - * Specifies the amount of perspective for a shape. + * Returns `true` if the bookmark is empty. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + isEmpty?: boolean; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Returns the name of the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + name?: string; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + start?: number; /** - * Specifies the angle of the lighting. + * Returns the story type for the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + } + /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ + export interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + export interface IndexData { /** - * Returns a `PresetCamera` value that represents the camera presets. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + range?: Word.Interfaces.RangeData; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Specifies the position of the light source relative to the extrusion. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the intensity of the extrusion lighting. + * Gets the number of columns for each page of the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + numberOfColumns?: number; /** - * Specifies the extrusion surface material. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + rightAlignPageNumbers?: boolean; /** - * Returns the preset extrusion format. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + separateAccentedLetterHeadings?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies the sorting criteria for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Gets the index type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: number; + type?: Word.IndexType | "Indent" | "Runin"; + } + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + export interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ + export interface ListTemplateCollectionData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ + export interface ListTemplateGalleryData { + } + /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ + export interface ListTemplateGalleryCollectionData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface EditorLoadOptions { /** - * Specifies the z-axis rotation of the camera. + 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 a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: number; + nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the position on the z-axis for the shape. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - export interface BibliographyData { + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sources?: Word.Interfaces.SourceData[]; + id?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: string; - } - /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ - export interface SourceCollectionData { - items?: Word.Interfaces.SourceData[]; + name?: boolean; } - /** An interface describing the data returned by calling `source.toJSON()`. */ - export interface SourceData { + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ConflictCollectionLoadOptions { /** - * Gets if the `Source` object has been cited in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - isCited?: boolean; + $all?: boolean; /** - * Gets the tag of the source. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; + type?: boolean; } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - export interface PageSetupData { + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ConflictLoadOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColumns?: Word.Interfaces.TextColumnData[]; + type?: boolean; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CritiqueAnnotationLoadOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + 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 range of text that is annotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrinting?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the number of pages for each booklet. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrintingSheets?: number; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationLoadOptions { /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldReversePrinting?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bottomMargin?: number; + id?: boolean; /** - * Specifies the number of characters per line in the document grid. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - charsLine?: number; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationCollectionLoadOptions { /** - * Specifies whether the first page has a different header and footer. + 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: Gets the critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - differentFirstPageHeaderFooter?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - footerDistance?: number; + id?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - gutter?: number; + state?: boolean; + } + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ApplicationLoadOptions { /** - * Specifies on which side the gutter appears in a document. + 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; + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + checkLanguage?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: number; + language?: boolean; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface BodyLoadOptions { /** - * Specifies the layout mode for the current document. + 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 text format of the body. Use this to get and set font name, size, color and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - leftMargin?: number; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the number of lines per page in the document grid. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linesPage?: number; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - mirrorMargins?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether odd and even pages have different headers and footers. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - oddAndEvenPagesHeaderFooter?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the orientation of the page. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the page height in points. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageHeight?: number; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the page width in points. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageWidth?: number; + style?: boolean; /** - * Specifies the paper size of the page. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + styleBuiltIn?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rightMargin?: number; + text?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + type?: boolean; + } + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface BorderLoadOptions { + /** + 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; /** - * Specifies the type of section break for the specified object. + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + color?: boolean; /** - * Specifies whether to show the grid. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - showGrid?: boolean; + location?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - suppressEndnotes?: boolean; + type?: boolean; /** - * Specifies the top margin of the page in points. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - topMargin?: number; + visible?: boolean; /** - * Specifies whether to print two pages per sheet. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - twoPagesOnOne?: boolean; + width?: boolean; + } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BorderUniversalLoadOptions { /** - * Specifies the vertical alignment of text on each page in a document or section. + 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; + /** + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - export interface LineNumberingData { + artStyle?: boolean; /** - * Specifies the numeric increment for line numbers. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: number; + artWidth?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + color?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + colorIndex?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + inside?: boolean; /** - * Specifies the starting line number. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: number; - } - /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ - export interface TextColumnCollectionData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface describing the data returned by calling `textColumn.toJSON()`. */ - export interface TextColumnData { + isVisible?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: number; + lineStyle?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + lineWidth?: boolean; } - /** An interface describing the data returned by calling `selection.toJSON()`. */ - export interface SelectionData { + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface BorderCollectionLoadOptions { /** - * Specifies the ending character position of the selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - end?: number; + $all?: boolean; /** - * Specifies the width in which Word fits the text in the current selection. + * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fitTextWidth?: number; + color?: boolean; /** - * Returns whether the spelling and grammar checker ignores the selected text. - If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - hasNoProofing?: boolean; + location?: boolean; /** - * Returns whether the selection in the specified window or pane is active. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isActive?: boolean; + type?: boolean; /** - * Specifies whether column selection mode is active. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isColumnSelectModeActive?: boolean; + visible?: boolean; /** - * Returns whether the selection is at the end-of-row mark in a table. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isEndOfRowMark?: boolean; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BorderUniversalCollectionLoadOptions { /** - * Specifies whether Extend mode is active. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - isExtendModeActive?: boolean; + $all?: boolean; /** - * Returns whether the insertion point is at the end of a line. + * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInsertionPointAtEndOfLine?: boolean; + artStyle?: boolean; /** - * Specifies whether the beginning of the selection is active. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive?: boolean; + artWidth?: boolean; /** - * Specifies whether Word has detected the language of the selected text. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + color?: boolean; /** - * Returns the language for the selection. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + colorIndex?: boolean; /** - * Returns the East Asian language for the selection. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + inside?: boolean; /** - * Returns the language for the selection that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies the orientation of text in the selection. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + lineStyle?: boolean; /** - * Specifies the starting character position of the selection. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BreakLoadOptions { /** - * Returns the number of characters in the story that contains the selection. + 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; + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the story type for the selection. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BreakCollectionLoadOptions { /** - * Specifies the text in the selection. + 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: Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the selection type. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; - } - /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ - export interface RangeScopedCollectionData { - items?: Word.Interfaces.RangeData[]; + pageIndex?: boolean; } - /** An interface describing the data returned by calling `bookmark.toJSON()`. */ - export interface BookmarkData { + /** + * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockLoadOptions { /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - range?: Word.Interfaces.RangeData; + $all?: boolean; /** - * Specifies the ending character position of the bookmark. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Returns `true` if the bookmark is a table column. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isColumn?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Returns `true` if the bookmark is empty. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEmpty?: boolean; + description?: boolean; /** - * Returns the name of the `Bookmark` object. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + id?: boolean; /** - * Specifies the starting character position of the bookmark. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + index?: boolean; /** - * Returns the story type for the bookmark. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - } - /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ - export interface BookmarkCollectionData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface describing the data returned by calling `index.toJSON()`. */ - export interface IndexData { + insertType?: boolean; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + name?: boolean; /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + value?: boolean; + } + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockCategoryLoadOptions { /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Gets the number of columns for each page of the index. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + index?: boolean; /** - * Specifies if page numbers are aligned with the right margin in the index. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + name?: boolean; + } + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockTypeItemLoadOptions { /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - separateAccentedLetterHeadings?: boolean; + $all?: boolean; /** - * Specifies the sorting criteria for the index. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + index?: boolean; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CheckboxContentControlLoadOptions { /** - * Gets the index type. + 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; + /** + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ - export interface IndexCollectionData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ - export interface ListTemplateCollectionData { - items?: Word.Interfaces.ListTemplateData[]; - } - /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ - export interface ListTemplateGalleryData { - } - /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ - export interface ListTemplateGalleryCollectionData { - items?: Word.Interfaces.ListTemplateGalleryData[]; + isChecked?: boolean; } /** - * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * Represents a coauthoring lock in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface EditorLoadOptions { + export interface CoauthoringLockLoadOptions { /** 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 a `Range` object that represents the next range that the editor has permissions to modify. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeLoadOptions; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60116,36 +68339,36 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - id?: boolean; - /** - * Gets the name of the editor. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + type?: boolean; } /** - * Represents the coauthoring conflicts in a Word document. + * Represents a collection of coauthoring locks in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface ConflictCollectionLoadOptions { + export interface CoauthoringLockCollectionLoadOptions { /** 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: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * For EACH ITEM in the collection: Gets the owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owner?: Word.Interfaces.CoauthorLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60153,7 +68376,7 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. + * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60162,749 +68385,822 @@ export declare namespace Word { type?: boolean; } /** - * Represents a coauthoring conflict in a Word document. + * Represents a coauthor in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface ConflictLoadOptions { + export interface CoauthorLoadOptions { /** 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + emailAddress?: boolean; /** - * Gets the `RevisionType` for the `Conflict` object. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * 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; + id?: boolean; /** - * Gets the range of text that is annotated. + * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + isMe?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: boolean; + name?: boolean; } /** - * Represents an annotation attached to a paragraph. + * Contains a collection of {@link Word.Coauthor} objects. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface AnnotationLoadOptions { + export interface CoauthorCollectionLoadOptions { /** 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. + * For EACH ITEM in the collection: Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + emailAddress?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ id?: boolean; /** - * Gets the state of the annotation. + * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; + isMe?: boolean; + /** + * For EACH ITEM in the collection: Gets the display name of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; } /** - * Contains a collection of {@link Word.Annotation} objects. + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface AnnotationCollectionLoadOptions { + export interface CoauthoringLoadOptions { /** 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; + $all?: boolean; + /** + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + me?: Word.Interfaces.CoauthorLoadOptions; /** - * For EACH ITEM in the collection: Gets the critique annotation object. + * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + canCoauthor?: boolean; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + canMerge?: boolean; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; + pendingUpdates?: boolean; } /** - * Represents the application object. + * Represents a coauthoring update in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ApplicationLoadOptions { + export interface CoauthoringUpdateLoadOptions { /** 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; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringUpdateCollectionLoadOptions { /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - checkLanguage?: boolean; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: boolean; + range?: Word.Interfaces.RangeLoadOptions; } /** - * Represents the body of a document or a section. + * Represents a comment in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - export interface BodyLoadOptions { + export interface CommentLoadOptions { /** 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 text format of the body. Use this to get and set font name, size, color and other properties. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * 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. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + authorEmail?: boolean; /** - * 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}. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + authorName?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + content?: boolean; /** - * 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}. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + creationDate?: boolean; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentSection?: Word.Interfaces.SectionLoadOptions; + id?: boolean; /** - * 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}. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + resolved?: boolean; + } + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentCollectionLoadOptions { /** - * 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. + 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: Specifies the comment's content range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - style?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - styleBuiltIn?: boolean; + authorEmail?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - text?: boolean; + authorName?: boolean; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * For EACH ITEM in the collection: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - type?: boolean; + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. - * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - export interface BorderLoadOptions { + export interface CommentContentRangeLoadOptions { /** 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; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + bold?: boolean; /** - * Gets the location of the border. + * 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. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - location?: boolean; + hyperlink?: boolean; /** - * Specifies the border type for the border. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - type?: boolean; + isEmpty?: boolean; /** - * Specifies whether the border is visible. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - visible?: boolean; + italic?: boolean; /** - * Specifies the width for the border. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - width?: boolean; + strikeThrough?: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + text?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: boolean; } /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * Represents a comment reply in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - export interface BorderUniversalLoadOptions { + export interface CommentReplyLoadOptions { /** 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; /** - * Specifies the graphical page-border design for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - artStyle?: boolean; - /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - artWidth?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: boolean; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - colorIndex?: boolean; + authorEmail?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - inside?: boolean; + authorName?: boolean; /** - * Specifies whether the border is visible. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isVisible?: boolean; + content?: boolean; /** - * Specifies the line style of the border. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lineStyle?: boolean; + creationDate?: boolean; /** - * Specifies the line width of an object's border. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lineWidth?: boolean; + id?: boolean; } /** - * Represents the collection of border styles. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - export interface BorderCollectionLoadOptions { + export interface CommentReplyCollectionLoadOptions { /** 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: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * For EACH ITEM in the collection: Specifies the commentReply's content range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the location of the border. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - location?: boolean; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * For EACH ITEM in the collection: Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - type?: boolean; + authorEmail?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - visible?: boolean; + authorName?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - width?: boolean; + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; } /** - * Represents the collection of {@link Word.BorderUniversal} objects. + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BorderUniversalCollectionLoadOptions { + export interface ConditionalStyleLoadOptions { /** 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: Specifies the graphical page-border design for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - artStyle?: boolean; - /** - * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + bottomPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + leftPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + rightPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; + topPadding?: boolean; } /** - * Represents a break in a Word document. + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BreakLoadOptions { + export interface XmlMappingLoadOptions { /** 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; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns the page number on which the break occurs. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; - } - /** - * Contains a collection of {@link Word.Break} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BreakCollectionLoadOptions { + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - 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`). + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isMapped?: boolean; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + prefixMappings?: boolean; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; + xpath?: boolean; } /** - * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BuildingBlockLoadOptions { + export interface CustomXmlPrefixMappingCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + namespaceUri?: boolean; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CustomXmlPrefixMappingLoadOptions { /** - * Specifies the description for the building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - description?: boolean; + $all?: boolean; /** - * Returns the internal identification number for the building block. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + namespaceUri?: boolean; /** - * Returns the position of this building block in a collection. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + prefix?: boolean; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CustomXmlSchemaLoadOptions { /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - insertType?: boolean; + $all?: boolean; /** - * Specifies the name of the building block. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + location?: boolean; /** - * Specifies the contents of the building block. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: boolean; + namespaceUri?: boolean; } /** - * Represents a category of building blocks in a Word document. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BuildingBlockCategoryLoadOptions { + export interface CustomXmlSchemaCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; - /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + location?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + namespaceUri?: boolean; } /** - * Represents a type of building block in a Word document. + * Represents a collection of {@link Word.CustomXmlValidationError} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BuildingBlockTypeItemLoadOptions { + export interface CustomXmlValidationErrorCollectionLoadOptions { /** 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; /** - * Returns the position of an item in a collection. + * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns the localized name of a building block type. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + errorCode?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - export interface CheckboxContentControlLoadOptions { /** - 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`). + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + text?: boolean; /** - * Specifies the current state of the checkbox. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; + type?: boolean; } /** - * Represents a coauthoring lock in a Word document. + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface CoauthoringLockLoadOptions { + export interface CustomXmlValidationErrorLoadOptions { /** 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 owner of the lock. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorLoadOptions; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + errorCode?: boolean; /** - * Gets a `CoauthoringLockType` value that represents the lock type. + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: boolean; + /** + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60913,976 +69209,856 @@ export declare namespace Word { type?: boolean; } /** - * Represents a collection of coauthoring locks in a Word document. + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface CoauthoringLockCollectionLoadOptions { + export interface CustomXmlNodeCollectionLoadOptions { /** 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: Gets the owner of the lock. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents a coauthor in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CoauthorLoadOptions { + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - 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`). + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the email address of the coauthor. + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the unique identifier for the `Coauthor` object. + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether this author represents the current user. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + baseName?: boolean; /** - * Gets the display name of the coauthor. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * Contains a collection of {@link Word.Coauthor} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CoauthorCollectionLoadOptions { + namespaceUri?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets the type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * For EACH ITEM in the collection: Gets the email address of the coauthor. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: boolean; + nodeValue?: boolean; /** - * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets whether this author represents the current user. + * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + xpath?: boolean; /** - * For EACH ITEM in the collection: Gets the display name of the coauthor. + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + xml?: boolean; } /** - * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface CoauthoringLoadOptions { + export interface CustomXmlNodeLoadOptions { /** 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 a `Coauthor` object that represents the current user. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - me?: Word.Interfaces.CoauthorLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether this document can be coauthored. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canCoauthor?: boolean; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether the document can be automatically merged. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canMerge?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether the document has pending updates that have not been accepted. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pendingUpdates?: boolean; - } - /** - * Represents a coauthoring update in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CoauthoringUpdateLoadOptions { - /** - 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; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; - } - /** - * Contains a collection of {@link Word.CoauthoringUpdate} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CoauthoringUpdateCollectionLoadOptions { - /** - 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; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; - } - /** - * Represents a comment in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentLoadOptions { - /** - 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; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the comment's content range. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + baseName?: boolean; /** - * Gets the email of the comment's author. + * Gets the unique address identifier for the namespace of the node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: boolean; + namespaceUri?: boolean; /** - * Gets the name of the comment's author. + * Gets the type of the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: boolean; + nodeType?: boolean; /** - * Specifies the comment's content as plain text. + * Specifies the value of the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + nodeValue?: boolean; /** - * Gets the creation date of the comment. + * Specifies the text for the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + text?: boolean; /** - * Gets the ID of the comment. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + xpath?: boolean; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Gets the XML representation of the current node and its children. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; + xml?: boolean; } /** - * Contains a collection of {@link Word.Comment} objects. + * 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.4] + * [Api set: WordApi 1.1] */ - export interface CommentCollectionLoadOptions { + export interface ContentControlLoadOptions { /** 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: Specifies the comment's content range. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] */ - authorEmail?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * 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.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - id?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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.4] - */ - resolved?: boolean; - } - /** - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentContentRangeLoadOptions { - /** - 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`). + * [Api set: WordApi 1.1] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a value that indicates whether the comment text is bold. + * 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.4] + * [Api set: WordApi 1.3] */ - bold?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. + * 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.4] + * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Checks whether the range length is zero. + * 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.4] + * [Api set: WordApi 1.3] */ - isEmpty?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a value that indicates whether the comment text is italicized. + * 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.4] + * [Api set: WordApi 1.3] */ - italic?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * 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.4] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the text of the comment range. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] - */ - underline?: boolean; - } - /** - * Represents a comment reply in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentReplyLoadOptions { - /** - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Specifies the commentReply's content range. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the parent comment of this reply. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + appearance?: boolean; /** - * Gets the email of the comment reply's author. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + cannotDelete?: boolean; /** - * Gets the name of the comment reply's author. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + cannotEdit?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + color?: boolean; /** - * Gets the creation date of the comment reply. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + id?: boolean; /** - * Gets the ID of the comment reply. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; - } - /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentReplyCollectionLoadOptions { + placeholderText?: boolean; /** - 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`). + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + removeWhenEdited?: boolean; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * Specifies the style name for the content control. 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. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + subtype?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + title?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + type?: boolean; } /** - * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - export interface ConditionalStyleLoadOptions { + export interface ContentControlCollectionLoadOptions { /** 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; /** - * Returns a `Font` object that represents the font formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; - /** - * Returns a `ShadingUniversal` object that represents the shading of the conditional style. + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bottomPadding?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rightPadding?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: boolean; - } - /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface XmlMappingLoadOptions { + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - 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`). + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlPrefixMappingCollectionLoadOptions { + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - 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`). + * 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] */ - $all?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefix?: boolean; - } - /** - * Represents a `CustomXmlPrefixMapping` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlPrefixMappingLoadOptions { - /** - 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; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; - } - /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlSchemaLoadOptions { + appearance?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + cannotDelete?: boolean; /** - * Gets the location of the schema on a computer. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - location?: boolean; + cannotEdit?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlSchemaCollectionLoadOptions { + color?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - location?: boolean; + placeholderText?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlValidationErrorCollectionLoadOptions { + removeWhenEdited?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - errorCode?: boolean; + subtype?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - name?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ text?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + */ + title?: boolean; + /** + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] */ type?: boolean; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Represents a list item in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - export interface CustomXmlValidationErrorLoadOptions { + export interface ContentControlListItemLoadOptions { /** 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + displayText?: boolean; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - errorCode?: boolean; + index?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - name?: boolean; + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + export interface ContentControlListItemCollectionLoadOptions { /** - * Gets the text in the `CustomXmlValidationError` object. + 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: Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - text?: boolean; + displayText?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - type?: boolean; + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Represents a custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export interface CustomXmlNodeCollectionLoadOptions { + export interface CustomPropertyLoadOptions { /** 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: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + key?: boolean; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + value?: boolean; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface CustomPropertyCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - baseName?: boolean; + value?: boolean; + } + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartLoadOptions { /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -61891,115 +70067,98 @@ export declare namespace Word { xml?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * Contains the collection of {@link Word.CustomXmlPart} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - export interface CustomXmlNodeLoadOptions { + export interface CustomXmlPartCollectionLoadOptions { /** 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 a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + builtIn?: boolean; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + id?: boolean; /** - * Gets the object representing the part associated with this node. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + namespaceUri?: boolean; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartScopedCollectionLoadOptions { /** - * Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * Gets the type of the current node. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the value of the current node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * Specifies the text for the current node. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -62008,855 +70167,883 @@ export declare namespace Word { xml?: 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, checkbox, dropdown list, and combo box content controls are supported. + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. * * @remarks * [Api set: WordApi 1.1] */ - export interface ContentControlLoadOptions { + export interface DocumentLoadOptions { /** 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 building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowLoadOptions; + /** + * Specifies a `Template` object that represents the template attached to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets a `Shape` object that represents the background image for the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + background?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * 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] */ - font?: Word.Interfaces.FontLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; - /** - * Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; + builtInDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** - * 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}. + * Gets a `Range` object that represents the main document story. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + content?: Word.Interfaces.RangeLoadOptions; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + customDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Returns a `PageSetup` object that's associated with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * 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}. + * Gets the properties of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * 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}. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + selection?: Word.Interfaces.SelectionLoadOptions; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the `WebSettings` object for webpage-related attributes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + webSettings?: Word.Interfaces.WebSettingsLoadOptions; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + activeTheme?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the display name of the active theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + activeThemeDisplayName?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: boolean; + areFilePropertiesPasswordEncrypted?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + areGrammaticalErrorsShown?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + areMathDefaultsUsed?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + areNewerFeaturesDisabled?: boolean; /** - * Gets an integer that represents the content control identifier. + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + areSpellingErrorsShown?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: boolean; + areStylesUpdatedOnOpen?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + areTrueTypeFontsEmbedded?: boolean; /** - * Specifies the style name for the content control. 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. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + autoHyphenation?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + autoSaveOn?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - subtype?: boolean; + changeTrackingMode?: boolean; /** - * Specifies a tag to identify a content control. + * Gets the code name for the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: boolean; + codeName?: boolean; /** - * Gets the text of the content control. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + compatibilityMode?: boolean; /** - * Specifies the title for a content control. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + consecutiveHyphensLimit?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface ContentControlCollectionLoadOptions { + currentRsid?: boolean; /** - 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`). + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + defaultTabStop?: boolean; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + defaultTargetFrame?: boolean; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + doNotEmbedSystemFonts?: boolean; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + encryptionProvider?: boolean; /** - * 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. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + farEastLineBreakLanguage?: boolean; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies the line break control level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + farEastLineBreakLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + formattingIsNextLevelShown?: boolean; /** - * 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. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + formattingIsUserStyleNameShown?: boolean; /** - * 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}. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + fullName?: boolean; /** - * 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. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + gridDistanceHorizontal?: boolean; /** - * 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. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + gridDistanceVertical?: boolean; /** - * 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}. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + gridIsOriginFromMargin?: boolean; /** - * 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}. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + gridOriginHorizontal?: boolean; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies the vertical origin point for the invisible grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + gridOriginVertical?: boolean; /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + gridSpaceBetweenHorizontalLines?: boolean; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + gridSpaceBetweenVerticalLines?: boolean; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: boolean; + hasPassword?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + hasVbProject?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + hyphenateCaps?: boolean; /** - * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + hyphenationZone?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + isAutoFormatOverrideOn?: boolean; /** - * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: boolean; + isChartDataPointTracked?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + isCompatible?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the content control. 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. + * Specifies whether the document is final. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isFinal?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + isFontsSubsetSaved?: boolean; /** - * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: boolean; + isFormsDataPrinted?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: boolean; + isFormsDataSaved?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + isGrammarChecked?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + isInAutoSave?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Represents a list item in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - export interface ContentControlListItemLoadOptions { + isInFormsDesign?: boolean; /** - 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`). + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isKerningByAlgorithm?: boolean; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + isLinguisticDataEmbedded?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + isMasterDocument?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - export interface ContentControlListItemCollectionLoadOptions { + isOptimizedForWord97?: boolean; /** - 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`). + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isPostScriptPrintedOverText?: boolean; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + isQuickStyleSetLocked?: boolean; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + isReadOnly?: boolean; /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface CustomPropertyLoadOptions { + isReadOnlyRecommended?: boolean; /** - 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`). + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSnappedToGrid?: boolean; /** - * Gets the key of the custom property. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + isSnappedToShapes?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + isSpellingChecked?: boolean; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.CustomProperty} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface CustomPropertyCollectionLoadOptions { + isStyleEnforced?: boolean; /** - 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`). + * Gets whether this document is a subdocument of a master document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSubdocument?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + isThemeLocked?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + isUserControl?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CustomXmlPartLoadOptions { + isVbaSigned?: boolean; /** - 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`). + * Gets whether the document is protected with a write password. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isWriteReserved?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the character spacing adjustment. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + justificationMode?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + kind?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + languageDetected?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + noLineBreakAfter?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CustomXmlPartCollectionLoadOptions { + noLineBreakBefore?: boolean; /** - 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`). + * Gets the encoding used to open the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + openEncoding?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Gets the title of the original document after legal-blackline comparison. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + originalDocumentTitle?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Sets a password that must be supplied to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + password?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + passwordEncryptionAlgorithm?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + passwordEncryptionKeyLength?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Gets the name of the password encryption provider. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CustomXmlPartScopedCollectionLoadOptions { + passwordEncryptionProvider?: boolean; /** - 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`). + * Gets the disk or the web path to the document (excludes the document name). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + path?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether revision marks are printed with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + printRevisions?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Gets the protection type for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + protectionType?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + readingLayoutSizeX?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + readingLayoutSizeY?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface DocumentLoadOptions { + readingModeIsLayoutFrozen?: boolean; /** - 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`). + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + removePersonalInformationOnSave?: boolean; /** - * Gets the active window for the document. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowLoadOptions; + revisedDocumentTitle?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies the encoding used when saving the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + saveEncoding?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Gets the file format of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + saveFormat?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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. * * @remarks * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + saved?: boolean; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. + * Specifies the encoding for saving as encoded text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coauthoring?: Word.Interfaces.CoauthoringLoadOptions; + textEncoding?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + textLineEnding?: boolean; /** - * Gets the properties of the document. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + trackFormatting?: boolean; /** - * Returns a `Selection` object that represents the current selection in the document. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection?: Word.Interfaces.SelectionLoadOptions; + trackMoves?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies whether changes are tracked in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + trackRevisions?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + trackedChangesAreDateAndTimeRemoved?: boolean; /** - * Specifies the ChangeTracking mode. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: boolean; + type?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Sets a password for saving changes to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: boolean; + writePassword?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + xmlAreAdvancedErrorsShown?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + xmlIsXsltUsedWhenSaving?: boolean; /** - * 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. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + xmlSaveThroughXSLT?: boolean; } /** * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. @@ -64696,7 +72883,7 @@ export declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - progID?: boolean; + progId?: boolean; } /** * Represents a page in the document. `Page` objects manage the page layout and content. @@ -71105,504 +79292,1057 @@ export declare namespace Word { title?: boolean; } /** - * Represents the `PictureContentControl` object. + * Represents the `PictureContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface PictureContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `GroupContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface GroupContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `BuildingBlockGalleryContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockGalleryContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the category for the building block content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockCategory?: boolean; + /** + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockType?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Gets if the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `RepeatingSectionContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface RepeatingSectionContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allowInsertDeleteSection?: boolean; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionItemTitle?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents one of the readability statistics for the document or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface PictureContentControlLoadOptions { + export interface ReadabilityStatisticLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns the name of the readability statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + name?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Returns the value of the grammar statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + value?: boolean; + } + /** + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ReadabilityStatisticCollectionLoadOptions { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + 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: Returns the name of the readability statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + name?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Returns the value of the grammar statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + value?: boolean; + } + /** + * Represents the settings for saving a Word document as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface WebSettingsLoadOptions { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + 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; + /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + allowPng?: boolean; /** - * Returns the identification for the content control. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + encoding?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + folderSuffix?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + organizeInFolder?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + pixelsPerInch?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + relyOnCSS?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + screenSize?: boolean; /** - * Specifies the title for the content control. + * Specifies the target browser for documents viewed in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + targetBrowser?: boolean; + /** + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useLongFileNames?: boolean; } /** - * Represents the `GroupContentControl` object. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface GroupContentControlLoadOptions { + export interface XmlNodeCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets the parent document of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the parent element of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Returns the identification for the content control. + * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * For EACH ITEM in the collection: Gets the name of the element without any prefix. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + baseName?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * For EACH ITEM in the collection: Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + hasChildNodes?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * For EACH ITEM in the collection: Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + level?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + namespaceUri?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + nodeType?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; - } - /** - * Represents the `BuildingBlockGalleryContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BuildingBlockGalleryContentControlLoadOptions { - /** - 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; + nodeValue?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + placeholderText?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + text?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + validationErrorText?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + validationStatus?: boolean; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface XmlNodeLoadOptions { /** - * Specifies the category for the building block content control. + 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 first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: boolean; + firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: boolean; + lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the identification for the content control. + * Gets the parent document of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the parent element of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the name of the element without any prefix. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + baseName?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + hasChildNodes?: boolean; /** - * Specifies a tag to identify the content control. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + level?: boolean; /** - * Specifies the title for the content control. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; - } - /** - * Represents the `RepeatingSectionContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface RepeatingSectionContentControlLoadOptions { + namespaceUri?: boolean; /** - 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`). + * Gets the type of node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + nodeValue?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + placeholderText?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + text?: boolean; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + validationErrorText?: boolean; /** - * Specifies the appearance of the content control. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + validationStatus?: boolean; + } + /** + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface HtmlDivisionLoadOptions { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + 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 a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the identification for the content control. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + leftIndent?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + rightIndent?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + spaceAfter?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + spaceBefore?: boolean; + } + /** + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface HtmlDivisionCollectionLoadOptions { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + 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: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * For EACH ITEM in the collection: Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: boolean; + leftIndent?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rightIndent?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + spaceAfter?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + spaceBefore?: boolean; } /** * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. @@ -71986,20 +80726,20 @@ export declare namespace Word { */ $all?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** * Indicates whether the `ListFormat` object contains a single list. @@ -73529,7 +82269,6 @@ export declare namespace Word { * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** @@ -73586,7 +82325,6 @@ export declare namespace Word { * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 3d243bea5f..1c69e77491 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -104561,7 +104561,7 @@ declare namespace Word { /** 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -104577,7 +104577,7 @@ declare namespace Word { */ readonly errorCode: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -106881,6 +106881,14 @@ declare namespace Word { * @beta */ attachedTemplate: Word.Template; + /** + * Gets a `Shape` object that represents the background image for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly background: Word.Shape; /** * Returns a `Bibliography` object that represents the bibliography references contained within the document. * @@ -106904,6 +106912,22 @@ declare namespace Word { * @beta */ readonly bookmarks: Word.BookmarkCollection; + /** + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly builtInDocumentProperties: Word.DocumentProperties; + /** + * Gets the `RangeScopedCollection` object that represents all the characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly characters: Word.RangeScopedCollection; /** * Gets a `Coauthoring` object for managing coauthoring in the document. * @@ -106912,6 +106936,22 @@ declare namespace Word { * @beta */ readonly coauthoring: Word.Coauthoring; + /** + * Gets a `CommentCollection` object that represents all the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly comments: Word.CommentCollection; + /** + * Gets a `Range` object that represents the main document story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly content: Word.Range; /** * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * @@ -106919,6 +106959,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; + /** + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly customDocumentProperties: Word.DocumentProperties; /** * Gets the custom XML parts in the document. * @@ -106934,6 +106982,14 @@ declare namespace Word { * @beta */ readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection; + /** + * Gets a `FieldCollection` object that represents all the fields in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fields: Word.FieldCollection; /** * Returns a `FrameCollection` object that represents all the frames in the document. * @@ -106942,6 +106998,14 @@ declare namespace Word { * @beta */ readonly frames: Word.FrameCollection; + /** + * Gets a `RangeCollection` object that represents the sentences that failed the grammar check in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly grammaticalErrors: Word.RangeCollection; /** * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * @@ -106958,6 +107022,14 @@ declare namespace Word { * @beta */ readonly indexes: Word.IndexCollection; + /** + * Gets a `ParagraphCollection` object that represents all the numbered paragraphs in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listParagraphs: Word.ParagraphCollection; /** * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * @@ -106966,6 +107038,14 @@ declare namespace Word { * @beta */ readonly listTemplates: Word.ListTemplateCollection; + /** + * Gets a `ListCollection` object that contains all the formatted lists in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly lists: Word.ListCollection; /** * Returns a `PageSetup` object that's associated with the document. * @@ -106974,6 +107054,14 @@ declare namespace Word { * @beta */ readonly pageSetup: Word.PageSetup; + /** + * Gets a `ParagraphCollection` object that represents all the paragraphs in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly paragraphs: Word.ParagraphCollection; /** * Gets the properties of the document. * @@ -106981,6 +107069,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly properties: Word.DocumentProperties; + /** + * Gets a `ReadabilityStatisticCollection` object that represents the readability statistics for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly readabilityStatistics: Word.ReadabilityStatisticCollection; /** * Gets the collection of revisions that represents the tracked changes in the document. * @@ -107004,6 +107100,14 @@ declare namespace Word { * @beta */ readonly selection: Word.Selection; + /** + * Gets the `RangeScopedCollection` object that represents all the sentences in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sentences: Word.RangeScopedCollection; /** * Gets the add-in's settings in the document. * @@ -107011,6 +107115,30 @@ declare namespace Word { * [Api set: WordApi 1.4] */ readonly settings: Word.SettingCollection; + /** + * Gets a `RangeCollection` object that represents the words identified as spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly spellingErrors: Word.RangeCollection; + /** + * Gets a `RangeCollection` object that represents all the stories in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyRanges: Word.RangeCollection; + /** + * Gets a `StyleCollection` for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly styles: Word.StyleCollection; /** * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. * @@ -107019,6 +107147,14 @@ declare namespace Word { * @beta */ readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; + /** + * Gets a `TableCollection` object that represents all the tables in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tables: Word.TableCollection; /** * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. * @@ -107043,6 +107179,14 @@ declare namespace Word { * @beta */ readonly tablesOfFigures: Word.TableOfFiguresCollection; + /** + * Gets the `WebSettings` object for webpage-related attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly webSettings: Word.WebSettings; /** * Gets the collection of `Word.Window` objects for the document. * @@ -107051,1827 +107195,1905 @@ declare namespace Word { */ readonly windows: Word.WindowCollection; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets the `RangeScopedCollection` object that represents each word in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation: boolean; + readonly words: Word.RangeScopedCollection; /** - * Specifies if the edits in the document are automatically saved. + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn: boolean; + readonly activeTheme: string; /** - * Specifies the ChangeTracking mode. + * Gets the display name of the active theme. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + readonly activeThemeDisplayName: string; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit: number; + readonly areFilePropertiesPasswordEncrypted: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps: boolean; + areGrammaticalErrorsShown: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies whether to use the default math settings when creating new equations. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected: boolean; + areMathDefaultsUsed: boolean; /** - * 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. + * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly saved: boolean; + areNewerFeaturesDisabled: boolean; /** - * 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. + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Document): void; + areSpellingErrorsShown: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: Word.StyleType): Word.Style; + areStylesUpdatedOnOpen: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + areTrueTypeFontsEmbedded: boolean; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - close(closeBehavior?: Word.CloseBehavior): void; + autoHyphenation: boolean; /** - * Closes the current document. - - Note: This API isn't supported in Word on the web. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.5] - * - * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - close(closeBehavior?: "Save" | "SkipSave"): void; + autoSaveOn: boolean; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param filePath Required. The path of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. + * [Api set: WordApi 1.4] */ - compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Displays revision marks that indicate where the specified document differs from another document. + * Gets the code name for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param base64File Required. The Base64-encoded content of the document with which the specified document is compared. - * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; + readonly codeName: string; /** - * Deletes a bookmark, if it exists, from the document. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteBookmark(name: string): void; + readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** - * Analyzes the document text to determine the language. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): void; + consecutiveHyphensLimit: number; /** - * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi 1.7] - * - * @param id The ID of the annotation to get. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAnnotationById(id: string): Word.Annotation; + readonly currentRsid: number; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRange(name: string): Word.Range; + defaultTabStop: number; /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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}. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi 1.4] - * - * @param name Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + defaultTargetFrame: string; /** - * Gets the currently supported content controls in the document. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + doNotEmbedSystemFonts: boolean; /** - * Gets the document's endnotes in a single body. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getEndnoteBody(): Word.Body; + encryptionProvider: string; /** - * Gets the document's footnotes in a single body. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFootnoteBody(): Word.Body; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. + * Specifies the line break control level. * * @remarks - * [Api set: WordApi 1.6] - * - * @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getParagraphByUniqueLocalId(id: string): Word.Paragraph; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the current selection of the document. Multiple selections aren't supported. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getSelection(): Word.Range; + formattingIsNextLevelShown: boolean; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getStyles(): Word.StyleCollection; + formattingIsUserStyleNameShown: boolean; /** - * Import styles from a JSON-formatted string. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; + readonly fullName: string; /** - * Import styles from a JSON-formatted string. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.6] - * - * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. - * - * @param stylesJson Required. A JSON-formatted string representing the styles. - * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; + gridDistanceHorizontal: number; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.5] - * - * 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'. - * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + gridDistanceVertical: number; /** - * Initiates manual hyphenation of a document, one line at a time. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manualHyphenation(): void; + gridIsOriginFromMargin: boolean; /** - * Saves the document. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + gridOriginHorizontal: number; /** - * Saves the document. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. - * - * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + gridOriginVertical: number; /** - * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + gridSpaceBetweenHorizontalLines: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the interval for vertical character gridlines in print layout view. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; + gridSpaceBetweenVerticalLines: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether a password is required to open the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Document; + readonly hasPassword: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Document; + readonly hasVbProject: boolean; /** - * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationClicked: OfficeExtension.EventHandlers; + hyphenateCaps: boolean; /** - * Occurs when the user hovers the cursor over an annotation. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationHovered: OfficeExtension.EventHandlers; + hyphenationZone: number; /** - * Occurs when the user adds one or more annotations. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationInserted: OfficeExtension.EventHandlers; + isAutoFormatOverrideOn: boolean; /** - * Occurs when the user performs an action in an annotation pop-up menu. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi 1.8] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; + isChartDataPointTracked: boolean; /** - * Occurs when the user deletes one or more annotations. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi 1.7] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onAnnotationRemoved: OfficeExtension.EventHandlers; + isCompatible: boolean; /** - * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. + * Specifies whether the document is final. * * @remarks - * [Api set: WordApi 1.5] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onContentControlAdded: OfficeExtension.EventHandlers; + isFinal: boolean; /** - * Occurs when the user adds new paragraphs. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphAdded: OfficeExtension.EventHandlers; + isFontsSubsetSaved: boolean; /** - * Occurs when the user changes paragraphs. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphChanged: OfficeExtension.EventHandlers; + isFormsDataPrinted: boolean; /** - * Occurs when the user deletes paragraphs. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi 1.6] - * - * @eventproperty + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly onParagraphDeleted: OfficeExtension.EventHandlers; + isFormsDataSaved: boolean; /** - * 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. + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Document; + isGrammarChecked: boolean; /** - * 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. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Document; + readonly isInAutoSave: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Gets whether the document is in form design mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentData; - } - /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class DocumentCreated 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; + readonly isInFormsDesign: boolean; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + isKerningByAlgorithm: boolean; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly contentControls: Word.ContentControlCollection; + isLinguisticDataEmbedded: boolean; /** - * Gets the custom XML parts in the document. + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly customXmlParts: Word.CustomXmlPartCollection; + readonly isMasterDocument: boolean; /** - * Gets the properties of the document. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly properties: Word.DocumentProperties; + isOptimizedForWord97: boolean; /** - * Gets the collection of section objects in the document. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly sections: Word.SectionCollection; + isPostScriptPrintedOverText: boolean; /** - * Gets the add-in's settings in the document. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly settings: Word.SettingCollection; + isQuickStyleSetLocked: boolean; /** - * 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. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly saved: boolean; + readonly isReadOnly: boolean; /** - * 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. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentCreated): void; + isReadOnlyRecommended: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: Word.StyleType): Word.Style; + isSnappedToGrid: boolean; /** - * Adds a style into the document by name and type. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * @param name Required. A string representing the style name. - * @param type Required. The style type, including character, list, paragraph, or table. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; + isSnappedToShapes: boolean; /** - * Deletes a bookmark, if it exists, from the document. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteBookmark(name: string): void; + isSpellingChecked: boolean; /** - * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name Required. The case-insensitive bookmark name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRange(name: string): Word.Range; + isStyleEnforced: boolean; /** - * Gets a bookmark's range. If the bookmark doesn't exist, 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}. + * Gets whether this document is a subdocument of a master document. * * @remarks - * [Api set: WordApiHiddenDocument 1.4] - * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBookmarkRangeOrNullObject(name: string): Word.Range; + readonly isSubdocument: boolean; /** - * Gets the currently supported content controls in the document. + * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + isThemeLocked: boolean; /** - * Gets a StyleCollection object that represents the whole style set of the document. + * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getStyles(): Word.StyleCollection; + isUserControl: boolean; /** - * Inserts a document into the target document at a specific location with additional properties. - Headers, footers, watermarks, and other section properties are copied by default. + * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApiHiddenDocument 1.5] - * - * 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'. - * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; + readonly isVbaSigned: boolean; /** - * Opens the document. + * Gets whether the document is protected with a write password. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - open(): void; + readonly isWriteReserved: boolean; /** - * Saves the document. + * Specifies the character spacing adjustment. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Saves the document. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] - * - * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. - * - * @param saveBehavior Optional. DocumentCreated only supports 'Save'. - * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word has detected the language of the document text. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; + languageDetected: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the kinsoku characters after which Word will not break a line. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentCreated; + noLineBreakAfter: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the kinsoku characters before which Word will not break a line. * - * @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.DocumentCreated; - /** - * 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.DocumentCreated; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentCreatedData; - } - /** - * Represents document properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class DocumentProperties 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; + noLineBreakBefore: string; /** - * Gets the collection of custom properties of the document. + * Gets the encoding used to open the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly customProperties: Word.CustomPropertyCollection; + readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the application name of the document. + * Gets the title of the original document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly applicationName: string; + readonly originalDocumentTitle: string; /** - * Specifies the author of the document. + * Sets a password that must be supplied to open the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author: string; + password: string; /** - * Specifies the category of the document. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category: string; + readonly passwordEncryptionAlgorithm: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments: string; + readonly passwordEncryptionKeyLength: number; /** - * Specifies the company of the document. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company: string; + readonly passwordEncryptionProvider: string; /** - * Gets the creation date of the document. + * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly creationDate: Date; + readonly path: string; /** - * Specifies the format of the document. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format: string; + printRevisions: boolean; /** - * Specifies the keywords of the document. + * Gets the protection type for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords: string; + readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** - * Gets the last author of the document. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastAuthor: string; + readingLayoutSizeX: number; /** - * Gets the last print date of the document. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastPrintDate: Date; + readingLayoutSizeY: number; /** - * Gets the last save time of the document. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly lastSaveTime: Date; + readingModeIsLayoutFrozen: boolean; /** - * Specifies the manager of the document. + * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager: string; + removePersonalInformationOnSave: boolean; /** - * Gets the revision number of the document. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly revisionNumber: string; + readonly revisedDocumentTitle: string; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly security: number; + saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the subject of the document. + * Gets the file format of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject: string; + readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Gets the template of the document. + * 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly template: string; + readonly saved: boolean; /** - * Specifies the title of the document. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi 1.3] - */ - title: string; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DocumentProperties): void; + textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies how Word marks line and paragraph breaks in text files. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; + textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to track formatting changes when change tracking is on. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentProperties; + trackFormatting: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to mark moved text when Track Changes is on. * - * @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.DocumentProperties; - /** - * 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.DocumentProperties; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.DocumentProperties; + trackMoves: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentPropertiesData; - } - /** - * The data specific to content controls of type DropDownList. - * - * @remarks - * [Api set: WordApi 1.9] - */ - class DropDownListContentControl 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; + trackRevisions: boolean; /** - * Gets the collection of list items in the dropdown list content control. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listItems: Word.ContentControlListItemCollection; + trackedChangesAreDateAndTimeRemoved: boolean; /** - * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApi 1.9] - * - * @param displayText Required. Display text of the list item. - * @param value Optional. Value of the list item. - * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + readonly type: Word.DocumentType | "Document" | "Template" | "Frameset"; /** - * Deletes all list items in this dropdown list content control. + * Sets a password for saving changes to the document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteAllListItems(): void; + writePassword: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DropDownListContentControl; + xmlAreAdvancedErrorsShown: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DropDownListContentControl; + xmlIsXsltUsedWhenSaving: boolean; /** - * 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. + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.DropDownListContentControl; + xmlSaveThroughXSLT: string; /** - * 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. + * 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. */ - 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. - */ - toJSON(): Word.Interfaces.DropDownListContentControlData; - } - /** - * The data specific to content controls of type 'ComboBox'. - * - * @remarks - * [Api set: WordApi 1.9] - */ - class ComboBoxContentControl 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; + set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Document): void; /** - * Gets the collection of list items in the combo box content control. + * Accepts all tracked changes in the document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listItems: Word.ContentControlListItemCollection; + acceptAllRevisions(): void; /** - * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. + * Accepts all revisions in the document that are displayed on the screen. * * @remarks - * [Api set: WordApi 1.9] - * - * @param displayText Required. Display text of the list item. - * @param value Optional. Value of the list item. - * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; + acceptAllRevisionsShown(): void; /** - * Deletes all list items in this combo box content control. + * Activates the document so that it becomes the active document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteAllListItems(): void; + activate(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds a style into the document by name and type. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ComboBoxContentControl; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.5] * - * @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.ComboBoxContentControl; - /** - * 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. + * @param name Required. A string representing the style name. + * @param type Required. The style type, including character, list, paragraph, or table. */ - track(): Word.ComboBoxContentControl; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * 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. + * Adds a style into the document by name and type. + * + * @remarks + * [Api set: WordApi 1.5] + * + * @param name Required. A string representing the style name. + * @param type Required. The style type, including character, list, paragraph, or table. */ - 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. - */ - toJSON(): Word.Interfaces.ComboBoxContentControlData; - } - /** - * Represents a field. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - class Field 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; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Gets a `LinkFormat` object that represents the link options of the field. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly linkFormat: Word.LinkFormat; + addToFavorites(): void; /** - * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. + * Applies the specified Quick Style set to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style The style set to apply. */ - readonly oleFormat: Word.OleFormat; + applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void; /** - * Gets the parent body of the field. + * Applies the specified Quick Style set to the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param style The style set to apply. */ - readonly parentBody: Word.Body; + applyQuickStyleSet(style: "SessionStart" | "Template"): void; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Applies the specified theme to this document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the theme. */ - readonly parentContentControl: Word.ContentControl; + applyTheme(name: string): void; /** - * 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}. + * Automatically formats the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentContentControlOrNullObject: Word.ContentControl; + autoFormat(): void; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Returns `true` if Microsoft Word can check in the document to a server. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns `true` if the document can be checked in; otherwise, `false`. */ - readonly parentTable: Word.Table; + canCheckin(): OfficeExtension.ClientResult; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Searches all text in a Japanese language document and displays instances where character usage is inconsistent for the same words. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTableCell: Word.TableCell; + checkConsistencyJapanese(): void; /** - * 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}. + * Begins a spelling and grammar check for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTableCellOrNullObject: Word.TableCell; + checkGrammar(): void; /** - * 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}. + * Checks in the document from the local computer to a server and sets the local document to read-only so that it cannot be edited locally. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for checking in the document. */ - readonly parentTableOrNullObject: Word.Table; + checkIn(options?: Word.DocumentCheckInOptions): void; /** - * Gets the field's result data. + * Saves the document to a server from a local computer, and sets the local document to read-only so that it cannot be edited locally. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for checking in the document with version control. */ - readonly result: Word.Range; + checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void; /** - * Specifies the field's code instruction. + * Begins a spelling check for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @param options Optional. Configuration options for the spell checking operation. */ - code: string; + checkSpelling(options?: Word.DocumentCheckSpellingOptions): void; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] + * + * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. */ - data: string; + close(closeBehavior?: Word.CloseBehavior): void; /** - * Gets the field's kind. + * Closes the current document. + + Note: This API isn't supported in Word on the web. * * @remarks * [Api set: WordApi 1.5] + * + * @param closeBehavior Optional. The close behavior must be 'Save' or 'SkipSave'. Default value is 'Save'. */ - readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + close(closeBehavior?: "Save" | "SkipSave"): void; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Switches the document from print preview to the previous view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked: boolean; + closePrintPreview(): void; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Displays revision marks that indicate where the specified document differs from another document. * * @remarks * [Api set: WordApiDesktop 1.1] + * + * @param filePath Required. The path of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specifies the behavior of comparing document. */ - showCodes: boolean; + compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Gets the field's type. + * Displays revision marks that indicate where the specified document differs from another document. * * @remarks - * [Api set: WordApi 1.5] - */ - readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; - /** - * 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. + * [Api set: WordApiDesktop 1.2] + * + * @param base64File Required. The Base64-encoded content of the document with which the specified document is compared. + * @param documentCompareOptions Optional. The additional options that specify the behavior for comparing the documents. Note that the `compareTarget` option isn't allowed to be `CompareTargetSelected` in this API. */ - set(properties: Interfaces.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Field): void; + compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void; /** - * Copies the field to the Clipboard. + * Returns a statistic based on the contents of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param statistic The type of statistic to return. + * @param includeFootnotesAndEndnotes Optional. Whether to include footnotes and endnotes. The default value is `false`. */ - copyToClipboard(): void; + computeStatistics(statistic: Word.Statistic, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; /** - * Removes the field from the document and places it on the Clipboard. + * Returns a statistic based on the contents of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param statistic The type of statistic to return. + * @param includeFootnotesAndEndnotes Optional. Whether to include footnotes and endnotes. The default value is `false`. */ - cut(): void; + computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult; /** - * Deletes the field. + * Converts the file to the newest format and enables all features. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + convert(): void; /** - * Clicks the field. + * Converts automatic hyphens to manual hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doClick(): void; + convertAutoHyphens(): void; /** - * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType Optional. The type of numbering to convert. */ - getNext(): Word.Field; + convertNumbersToText(numberType?: Word.NumberType): void; /** - * Gets the next field. If this field is the last one, 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}. + * Changes the list numbers and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document to text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType Optional. The type of numbering to convert. */ - getNextOrNullObject(): Word.Field; + convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Selects the field. + * Reconverts a Vietnamese document to Unicode using a code page other than the default. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param codePageOrigin The code page to use. */ - select(selectionMode?: Word.SelectionMode): void; + convertVietnameseDocument(codePageOrigin: number): void; /** - * Selects the field. + * Copies styles from the specified template to the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param StyleTemplate The template to copy styles from. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + copyStylesFromTemplate(StyleTemplate: string): void; /** - * Replaces the field with its most recent result. + * Returns the number of bulleted or numbered items and {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | LISTNUM fields} in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Configuration options for counting numbered items. + * @returns The count of numbered items. */ - unlink(): void; + countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Updates the field. + * Deletes all comments from the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - updateResult(): void; + deleteAllComments(): void; /** - * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. + * Deletes all revisions in the document that are displayed on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - updateSource(): void; + deleteAllCommentsShown(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes all handwritten ink annotations in the document. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; + deleteAllInkAnnotations(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes a bookmark, if it exists, from the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.4] + * + * @param name Required. The case-insensitive bookmark name. */ - load(propertyNames?: string | string[]): Word.Field; + deleteBookmark(name: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Analyzes the document text to determine the language. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Field; + detectLanguage(): void; /** - * 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. + * Terminates a review of the file that has been sent for review. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for ending the review process. */ - track(): Word.Field; + endReview(options?: Word.DocumentEndReviewOptions): void; /** - * 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. + * Saves the document in PDF or XPS format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName The name of the output file. + * @param exportFormat The export format. + * @param options Optional. Configuration options for the export operation. */ - untrack(): Word.Field; + exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Saves the document in PDF or XPS format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName The name of the output file. + * @param exportFormat The export format. + * @param options Optional. Configuration options for the export operation. */ - toJSON(): Word.Interfaces.FieldData; - } - /** - * Contains a collection of {@link Word.Field} objects. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - class FieldCollection 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.Field[]; + exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void; /** - * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Saves the document in PDF or XPS format. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName The output file name. + * @param exportFormat The format to export (PDF/XPS). + * @param options Optional. Configuration options for the export operation. */ - getFirst(): Word.Field; + exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void; /** - * Gets the first field 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}. + * Saves the document in PDF or XPS format. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName The output file name. + * @param exportFormat The format to export (PDF/XPS). + * @param options Optional. Configuration options for the export operation. */ - getFirstOrNullObject(): Word.Field; + exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void; /** - * Gets the Field object collection including the specified types of fields. + * Saves the document in PDF or XPS format with improved tagging. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param types Required. An array of field types. + * @param outputFileName The output file name. + * @param exportFormat The format to export (PDF/XPS). + * @param options Optional. Configuration options for the export operation. */ - getByTypes(types: Word.FieldType[]): Word.FieldCollection; + exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Saves the document in PDF or XPS format with improved tagging. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param outputFileName The output file name. + * @param exportFormat The format to export (PDF/XPS). + * @param options Optional. Configuration options for the export operation. */ - load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; + exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Decreases the font size of text just enough so that the document page count drops by one. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.FieldCollection; + fitToPages(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Displays a cached document, if it has already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for following the hyperlink. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; + followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void; /** - * 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. + * Fixes the layout of the document in Web view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.FieldCollection; + freezeLayout(): void; /** - * 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. + * Gets the annotation by ID. Throws an `ItemNotFound` error if annotation isn't found. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param id The ID of the annotation to get. */ - untrack(): Word.FieldCollection; + getAnnotationById(id: string): 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.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. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param name Required. The case-insensitive bookmark name. */ - toJSON(): Word.Interfaces.FieldCollectionData; - } - /** - * Represents a font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class Font 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; + getBookmarkRange(name: string): Word.Range; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Gets a bookmark's range. If the bookmark doesn't exist, 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 + * [Api set: WordApi 1.4] + * + * @param name Required. The case-insensitive bookmark name. */ - readonly borders: Word.BorderUniversalCollection; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Gets the currently supported content controls in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options Optional. Options that define which content controls are returned. */ - readonly fill: Word.FillFormat; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param referenceType The type of reference. */ - readonly glow: Word.GlowFormat; + getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Returns an array of items that can be cross-referenced based on the specified cross-reference type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param referenceType The type of reference. */ - readonly line: Word.LineFormat; + getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Gets the document's endnotes in a single body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly reflection: Word.ReflectionFormat; + getEndnoteBody(): Word.Body; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Gets the document's footnotes in a single body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly textColor: Word.ColorFormat; + getFootnoteBody(): Word.Body; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets the paragraph by its unique local ID. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + * + * @param id Required. Unique local ID in standard 8-4-4-4-12 GUID format without curly braces. Note that the ID differs across sessions and coauthors. */ - readonly textShadow: Word.ShadowFormat; + getParagraphByUniqueLocalId(id: string): Word.Paragraph; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Returns a `Range` object by using the specified starting and ending character positions. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Configuration options for specifying the range parameters. */ - readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; + getRange(options?: Word.DocumentRangeOptions): Word.Range; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets the current selection of the document. Multiple selections aren't supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - allCaps: boolean; + getSelection(): Word.Range; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a StyleCollection object that represents the whole style set of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - bold: boolean; + getStyles(): Word.StyleCollection; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Returns a `Range` object that represents the start position of the specified item, such as a page, bookmark, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Configuration options for specifying the `goTo` parameters. */ - boldBidirectional: boolean; + goTo(options?: Word.GoToOptions): Word.Range; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson Required. A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. */ - color: string; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Import styles from a JSON-formatted string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + * + * Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1. + * + * @param stylesJson Required. A JSON-formatted string representing the styles. + * @param importedStylesConflictBehavior Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document. */ - colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * 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'. + * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ - colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * Specifies whether contextual alternates are enabled for the font. + * Locks the file on the server preventing anyone else from editing it. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates: boolean; + lockServerFile(): void; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Sets the compatibility options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor: string; + makeCompatibilityDefault(): void; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Initiates manual hyphenation of a document, one line at a time. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid: boolean; + manualHyphenation(): void; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Merges the changes marked with revision marks from one document to another. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param fileName The name of the file to merge. + * @param options Optional. Configuration options for the merge operation. */ - doubleStrikeThrough: boolean; + merge(fileName: string, options?: Word.DocumentMergeOptions): void; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Posts the document to a public folder in Microsoft Exchange. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss: boolean; + post(): void; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Opens PowerPoint with the Word document loaded. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + presentIt(): void; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Prints all or part of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Configuration options for the print operation. */ - engrave: boolean; + printOut(options?: Word.DocumentPrintOutOptions): void; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Switches the view to print preview. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden: boolean; + printPreview(): void; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Protects the document from unauthorized changes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of protection. + * @param options Optional. Configuration options for document protection. */ - highlightColor: string; + protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Protects the document from unauthorized changes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of protection. + * @param options Optional. Configuration options for document protection. */ - italic: boolean; + protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Redoes the last action that was undone (reverses the `undo` method). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param times Optional. The number of actions to redo. + * @returns `true` if the actions were redone successfully; otherwise, `false`. */ - italicBidirectional: boolean; + redo(times?: number): OfficeExtension.ClientResult; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Rejects all tracked changes in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning: number; + rejectAllRevisions(): void; /** - * Specifies the ligature setting for the `Font` object. + * Rejects all revisions in the document that are displayed on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + rejectAllRevisionsShown(): void; /** - * Specifies a value that represents the name of the font. + * Reloads a cached document by resolving the hyperlink to the document and downloading it. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name: string; + reload(): void; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Reloads the document based on an HTML document, using the document encoding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param encoding The encoding to use. */ - nameAscii: string; + reloadAs(encoding: Word.DocumentEncoding): void; /** - * Specifies the font name in a right-to-left language document. + * Reloads the document based on an HTML document, using the document encoding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param encoding The encoding to use. */ - nameBidirectional: string; + reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void; /** - * Specifies the East Asian font name. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param removeDocInfoType The type of document info to remove. */ - nameFarEast: string; + removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void; /** - * Specifies the font used for characters with codes from 128 through 255. + * Removes sensitive information, properties, comments, and other metadata from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param removeDocInfoType The type of document info to remove. */ - nameOther: string; + removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void; /** - * Specifies the number form setting for an OpenType font. + * Purges the document of locked styles when formatting restrictions have been applied in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + removeLockedStyles(): void; /** - * Specifies the number spacing setting for the font. + * Removes numbers or bullets from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of numbering to remove. */ - numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + removeNumbers(numberType?: Word.NumberType): void; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Removes numbers or bullets from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of numbering to remove. */ - outline: boolean; + removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Specifies the position of text (in points) relative to the base line. + * Removes the active theme from the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position: number; + removeTheme(): void; /** - * Specifies the scaling percentage applied to the font. + * Repaginates the entire document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling: number; + repaginate(): void; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Sends an email message to the author of the document that has been sent out for review, notifying them that a reviewer has completed review of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Configuration options for replying with changes. */ - shadow: boolean; + replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void; /** - * Specifies a value that represents the font size in points. + * Clears all form fields in the document, preparing the form to be filled in again. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size: number; + resetFormFields(): void; /** - * Specifies the font size in points for right-to-left text. + * Returns the document to the last saved reading position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional: number; + returnToLastReadPosition(): OfficeExtension.ClientResult; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param autoMacro The auto macro to run. */ - smallCaps: boolean; + runAutoMacro(autoMacro: Word.AutoMacro): void; /** - * Specifies the spacing between characters. + * Runs an auto macro that's stored in the document. If the specified auto macro doesn't exist, nothing happens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param autoMacro The auto macro to run. */ - spacing: number; + runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Saves the document. * * @remarks * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - strikeThrough: boolean; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Specifies the stylistic set for the font. + * Saves the document. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApi 1.5. + * + * @param saveBehavior Optional. The save behavior must be 'Save' or 'Prompt'. Default value is 'Save'. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. + */ + save(saveBehavior?: "Save" | "Prompt", fileName?: string): void; + /** + * Saves the group of quick styles currently in use. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param fileName The name of the file to save. */ - stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + saveAsQuickStyleSet(fileName: string): void; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Performs a search with the specified search options on the scope of the whole document. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.7] */ - subscript: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Selects the contents of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - superscript: boolean; + select(): void; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Returns all content controls with the specified tag. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param tag The tag value to filter content controls. */ - underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + selectContentControlsByTag(tag: string): Word.ContentControlCollection; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ContentControlCollection` object that represents all the content controls in the document with the specified title. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param title The title of the content controls. */ - underlineColor: string; + selectContentControlsByTitle(title: string): Word.ContentControlCollection; /** - * 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. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are linked to the specific custom XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param node The custom XML node. */ - set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Font): void; + selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection; /** - * Decreases the font size to the next available size. + * Returns an `XmlNodeCollection` object that represents all the nodes that match the XPath parameter in the order in which they appear in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xPath The XPath expression. + * @param options Optional. Configuration options for the nodes selection. */ - decreaseFontSize(): void; + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** - * Increases the font size to the next available size. + * Returns an `XmlNode` object that represents the first node that matches the XPath parameter in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xPath The XPath expression. + * @param options Optional. Configuration options for the node selection. */ - increaseFontSize(): void; + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * Removes manual character formatting. + * Returns a `ContentControlCollection` object that represents all content controls in the document that are not linked to an XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param stream Optional. The custom XML part. */ - reset(): void; + selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection; /** - * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * Sends the document as a fax, without any user interaction. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param address The fax address. + * @param subject Optional. The subject of the fax. */ - setAsTemplateDefault(): void; + sendFax(address: string, subject?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sends the document to a fax service provider, who faxes the document to one or more specified recipients. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for sending the fax over the internet. */ - load(options?: Word.Interfaces.FontLoadOptions): Word.Font; + sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sends the document in an email message for review by the specified recipients. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Configuration options for sending the document for review. */ - load(propertyNames?: string | string[]): Word.Font; + sendForReview(options?: Word.DocumentSendForReviewOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Opens a message window for sending the document through Microsoft Exchange. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Font; + sendMail(): void; /** - * 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. + * Specifies the table style to use for newly created tables in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param style The style to apply. + * @param setInTemplate Whether to set the style in the template. */ - track(): Word.Font; + setDefaultTableStyle(style: string, setInTemplate: boolean): void; /** - * 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. + * Sets the options Microsoft Word uses for encrypting documents with passwords. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param passwordEncryptionProvider The encryption provider. + * @param passwordEncryptionAlgorithm The encryption algorithm. + * @param passwordEncryptionKeyLength The key length. + * @param passwordEncryptFileProperties Optional. Whether to encrypt file properties. */ - untrack(): Word.Font; + setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Switches form design mode on or off. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.FontData; - } - /** - * Represents a heading style used in a table of contents or table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class HeadingStyle 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; + toggleFormsDesign(): void; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * Applies the specified Extensible Stylesheet Language Transformation (XSLT) file to this document and replaces the document with the results. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param path The path to the XSLT file. + * @param dataOnly Optional. Whether to use data only. */ - level: number; + transformDocument(path: string, dataOnly?: boolean): void; /** - * Specifies the name of style for a heading. + * Undoes the last action or a sequence of actions, which are displayed in the Undo list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param times Optional. The number of actions to undo. + * @returns `true` if the actions were undone successfully; otherwise, `false`. */ - name: string; + undo(times?: number): OfficeExtension.ClientResult; /** - * 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. + * Clears the list of actions that can be undone in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.HeadingStyle): void; + undoClear(): void; /** - * Deletes the heading style. + * Removes protection from the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param password Optional. The password to unprotect the document. */ - delete(): void; + unprotect(password?: string): void; + /** + * Copies all styles from the attached template into the document, overwriting any existing styles in the document that have the same name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + updateStyles(): void; + /** + * Displays the code window for the selected Microsoft ActiveX control in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + viewCode(): void; + /** + * Displays the property window for the selected Microsoft ActiveX control in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + viewPropertyBrowser(): void; + /** + * Displays a preview of the current document as it would look if saved as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + webPagePreview(): 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.HeadingStyleLoadOptions): Word.HeadingStyle; + load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document; /** * 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.HeadingStyle; + load(propertyNames?: string | string[]): Word.Document; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -108880,603 +109102,533 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.HeadingStyle; + }): Word.Document; /** - * 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. + * Occurs when the user clicks an annotation (or selects it using **Alt+Down**). + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - track(): Word.HeadingStyle; + readonly onAnnotationClicked: OfficeExtension.EventHandlers; /** - * 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. + * Occurs when the user hovers the cursor over an annotation. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - untrack(): Word.HeadingStyle; + readonly onAnnotationHovered: OfficeExtension.EventHandlers; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. + * Occurs when the user adds one or more annotations. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - toJSON(): Word.Interfaces.HeadingStyleData; - } - /** - * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class HeadingStyleCollection 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.HeadingStyle[]; + readonly onAnnotationInserted: OfficeExtension.EventHandlers; /** - * Adds a new heading style to a document. + * Occurs when the user performs an action in an annotation pop-up menu. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.8] * - * @param name The style name to be added. - * @param level The heading level to assign. Must be a value from 1 to 9. - * @returns The new `HeadingStyle` object that was added to the collection. + * @eventproperty */ - add(name: string, level: number): Word.HeadingStyle; + readonly onAnnotationPopupAction: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user deletes one or more annotations. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.7] + * + * @eventproperty */ - load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; + readonly onAnnotationRemoved: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when a content control is added. Run context.sync() in the handler to get the new content control's properties. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.5] + * + * @eventproperty */ - load(propertyNames?: string | string[]): Word.HeadingStyleCollection; + readonly onContentControlAdded: OfficeExtension.EventHandlers; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Occurs when the user adds new paragraphs. * - * @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. + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HeadingStyleCollection; + readonly onParagraphAdded: OfficeExtension.EventHandlers; + /** + * Occurs when the user changes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphChanged: OfficeExtension.EventHandlers; + /** + * Occurs when the user deletes paragraphs. + * + * @remarks + * [Api set: WordApi 1.6] + * + * @eventproperty + */ + readonly onParagraphDeleted: OfficeExtension.EventHandlers; /** * 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.HeadingStyleCollection; + track(): Word.Document; /** * 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.HeadingStyleCollection; + 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.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.HeadingStyleCollectionData; + toJSON(): Word.Interfaces.DocumentData; } /** - * Represents a hyperlink in a Word document. + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - class Hyperlink extends OfficeExtension.ClientObject { + class DocumentCreated 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; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly range: Word.Range; + readonly body: Word.Body; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - address: string; + readonly contentControls: Word.ContentControlCollection; /** - * Specifies the text string for the hyperlink's subject line. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] */ - emailSubject: string; + readonly customXmlParts: Word.CustomXmlPartCollection; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly isExtraInfoRequired: boolean; + readonly properties: Word.DocumentProperties; /** - * Returns the name of the `Hyperlink` object. + * Gets the collection of section objects in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - readonly name: string; + readonly sections: Word.SectionCollection; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the add-in's settings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] */ - screenTip: string; + readonly settings: Word.SettingCollection; /** - * Specifies a named location in the destination of the hyperlink. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - subAddress: string; + readonly saved: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - target: string; + set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DocumentCreated): void; /** - * Specifies the hyperlink's visible text in the document. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name Required. A string representing the style name. + * @param type Required. The style type, including character, list, paragraph, or table. */ - textToDisplay: string; + addStyle(name: string, type: Word.StyleType): Word.Style; /** - * Returns the hyperlink type. + * Adds a style into the document by name and type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - /** - * 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. + * [Api set: WordApiHiddenDocument 1.5] + * + * @param name Required. A string representing the style name. + * @param type Required. The style type, including character, list, paragraph, or table. */ - set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Hyperlink): void; + addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style; /** - * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. + * Deletes a bookmark, if it exists, from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] + * + * @param name Required. The case-insensitive bookmark name. */ - addToFavorites(): void; + deleteBookmark(name: string): void; /** - * Creates a new document linked to the hyperlink. + * Gets a bookmark's range. Throws an `ItemNotFound` error if the bookmark doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.4] * - * @param fileName Required. The name of the file. - * @param editNow Required. `true` to start editing now. - * @param overwrite Required. `true` to overwrite if there's another file with the same name. + * @param name Required. The case-insensitive bookmark name. */ - createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; + getBookmarkRange(name: string): Word.Range; /** - * Deletes the hyperlink. + * Gets a bookmark's range. If the bookmark doesn't exist, 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 - */ - delete(): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApiHiddenDocument 1.4] * - * @param options Provides options for which properties of the object to load. + * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; + getBookmarkRangeOrNullObject(name: string): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the currently supported content controls in the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. + * + * @param options Optional. Options that define which content controls are returned. */ - load(propertyNames?: string | string[]): Word.Hyperlink; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets a StyleCollection object that represents the whole style set of the document. * - * @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. + * @remarks + * [Api set: WordApiHiddenDocument 1.5] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Hyperlink; + getStyles(): Word.StyleCollection; /** - * 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. + * Inserts a document into the target document at a specific location with additional properties. + Headers, footers, watermarks, and other section properties are copied by default. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.5] + * + * 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'. + * @param insertFileOptions Optional. The additional properties that should be imported to the destination document. */ - track(): Word.Hyperlink; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection; /** - * 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. + * Opens the document. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.Hyperlink; + open(): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. + * Saves the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + * + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - toJSON(): Word.Interfaces.HyperlinkData; - } - /** - * Contains a collection of {@link Word.Hyperlink} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class HyperlinkCollection 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.Hyperlink[]; + save(saveBehavior?: Word.SaveBehavior, fileName?: string): void; /** - * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. + * Saves the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] * - * @param anchor Required. The range to which the hyperlink is added. - * @param options Optional. The options to further configure the new hyperlink. + * Note: The `saveBehavior` and `fileName` parameters were introduced in WordApiHiddenDocument 1.5. + * + * @param saveBehavior Optional. DocumentCreated only supports 'Save'. + * @param fileName Optional. The file name (exclude file extension). Only takes effect for a new document. */ - add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; + save(saveBehavior?: "Save" | "Prompt", fileName?: string): 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.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; + load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated; /** * 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.HyperlinkCollection; + load(propertyNames?: string | string[]): Word.DocumentCreated; /** * 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.HyperlinkCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentCreated; /** * 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.HyperlinkCollection; + track(): Word.DocumentCreated; /** * 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.HyperlinkCollection; + 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.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.HyperlinkCollectionData; + toJSON(): Word.Interfaces.DocumentCreatedData; } /** - * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. + * Represents document properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface HyperlinkAddOptions { + class DocumentProperties 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; /** - * If provided, specifies the address (e.g., URL or file path) of the hyperlink. + * Gets the collection of custom properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - address?: string; + readonly customProperties: Word.CustomPropertyCollection; /** - * If provided, specifies the text that appears as a tooltip. + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - screenTip?: string; + readonly applicationName: string; /** - * If provided, specifies the location within the file or document. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - subAddress?: string; + author: string; /** - * If provided, specifies the name of the frame or window in which to load the hyperlink. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - target?: string; + category: string; /** - * If provided, specifies the visible text of the hyperlink. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - textToDisplay?: string; - } - /** - * Represents an inline picture. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class InlinePicture 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; + comments: string; /** - * Gets the parent paragraph that contains the inline image. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - readonly paragraph: Word.Paragraph; + company: string; /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly parentContentControl: Word.ContentControl; + readonly creationDate: Date; /** - * 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}. + * Specifies the format of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentContentControlOrNullObject: Word.ContentControl; + format: string; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies the keywords of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTable: Word.Table; + keywords: string; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the last author of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableCell: Word.TableCell; + readonly lastAuthor: string; /** - * 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}. + * Gets the last print date of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableCellOrNullObject: Word.TableCell; + readonly lastPrintDate: Date; /** - * 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}. + * Gets the last save time of the document. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentTableOrNullObject: Word.Table; - /** - * Specifies a string that represents the alternative text associated with the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - altTextDescription: string; + readonly lastSaveTime: Date; /** - * Specifies a string that contains the title for the inline image. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - altTextTitle: string; + manager: string; /** - * Specifies a number that describes the height of the inline image. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - height: number; + readonly revisionNumber: string; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - hyperlink: string; + readonly security: number; /** - * Gets the format of the inline image. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + subject: string; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the template of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + readonly template: string; /** - * Specifies a number that describes the width of the inline image. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - width: number; + title: string; /** * 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.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.DocumentPropertiesUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.InlinePicture): void; - /** - * Deletes the inline picture from the document. - * - * @remarks - * [Api set: WordApi 1.2] - */ - delete(): void; - /** - * Gets the Base64-encoded string representation of the inline image. - * - * @remarks - * [Api set: WordApi 1.1] - */ - getBase64ImageSrc(): OfficeExtension.ClientResult; - /** - * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.InlinePicture; - /** - * Gets the next inline image. If this inline image is the last one, 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] - */ - getNextOrNullObject(): Word.InlinePicture; - /** - * Gets the picture, or the starting or ending point of the picture, as a range. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. - */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; - /** - * Inserts a break at the specified location in the main document. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. - */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + set(properties: Word.DocumentProperties): void; /** - * Wraps the inline picture with a rich text content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param options Provides options for which properties of the object to load. */ - insertContentControl(): Word.ContentControl; + load(options?: Word.Interfaces.DocumentPropertiesLoadOptions): Word.DocumentProperties; /** - * Inserts a document at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * 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. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + load(propertyNames?: string | string[]): Word.DocumentProperties; /** - * Inserts HTML at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @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. */ - insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentProperties; /** - * Inserts an inline picture at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'. + * 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. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; + track(): Word.DocumentProperties; /** - * Inserts OOXML at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * 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. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + untrack(): Word.DocumentProperties; /** - * Inserts a paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.2] - * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + toJSON(): Word.Interfaces.DocumentPropertiesData; + } + /** + * The data specific to content controls of type DropDownList. + * + * @remarks + * [Api set: WordApi 1.9] + */ + class DropDownListContentControl 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; /** - * Inserts text at the specified location. + * Gets the collection of list items in the dropdown list content control. * * @remarks - * [Api set: WordApi 1.2] - * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.9] */ - insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; + readonly listItems: Word.ContentControlListItemCollection; /** - * Selects the inline picture. This causes Word to scroll to the selection. + * Adds a new list item to this dropdown list content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.9] * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param displayText Required. Display text of the list item. + * @param value Optional. Value of the list item. + * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - select(selectionMode?: Word.SelectionMode): void; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Selects the inline picture. This causes Word to scroll to the selection. + * Deletes all list items in this dropdown list content control. * * @remarks - * [Api set: WordApi 1.2] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. - */ - select(selectionMode?: "Select" | "Start" | "End"): 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. + * [Api set: WordApi 1.9] */ - load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; + deleteAllListItems(): void; /** * 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.InlinePicture; + load(propertyNames?: string | string[]): Word.DropDownListContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -109485,397 +109637,319 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.InlinePicture; + }): Word.DropDownListContentControl; /** * 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.InlinePicture; + track(): Word.DropDownListContentControl; /** * 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.InlinePicture; + 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.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; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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; } /** - * Contains a collection of {@link Word.InlinePicture} objects. + * The data specific to content controls of type 'ComboBox'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.9] */ - class InlinePictureCollection extends OfficeExtension.ClientObject { + class ComboBoxContentControl 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.InlinePicture[]; /** - * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the collection of list items in the combo box content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] */ - getFirst(): Word.InlinePicture; + readonly listItems: Word.ContentControlListItemCollection; /** - * Gets the first inline image 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}. + * Adds a new list item to this combo box content control and returns a {@link Word.ContentControlListItem} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.9] + * + * @param displayText Required. Display text of the list item. + * @param value Optional. Value of the list item. + * @param index Optional. Index location of the new item in the list. If an item exists at the position specified, the existing item is pushed down in the list. If omitted, the new item is added to the end of the list. */ - getFirstOrNullObject(): Word.InlinePicture; + addListItem(displayText: string, value?: string, index?: number): Word.ContentControlListItem; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Deletes all list items in this combo box content control. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.9] */ - load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; + deleteAllListItems(): void; /** * 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.InlinePictureCollection; + load(propertyNames?: string | string[]): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + track(): Word.ComboBoxContentControl; /** * 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.InlinePictureCollection; + 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.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; + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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; } /** - * Represents the linking characteristics for an OLE object or picture. + * Represents a field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - class LinkFormat extends OfficeExtension.ClientObject { + class Field 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; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated: boolean; + readonly linkFormat: Word.LinkFormat; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked: boolean; + readonly oleFormat: Word.OleFormat; /** - * Specifies if the linked picture is saved with the document. + * Gets the parent body of the field. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isPictureSavedWithDocument: boolean; + readonly parentBody: Word.Body; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sourceFullName: string; + readonly parentContentControl: Word.ContentControl; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly sourceName: string; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly sourcePath: string; + readonly parentTable: Word.Table; /** - * Gets the link type. + * 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 BETA (PREVIEW ONLY)] - * @beta - */ - readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - /** - * 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. + * [Api set: WordApi 1.4] */ - set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LinkFormat): void; + readonly parentTableCell: Word.TableCell; /** - * Breaks the link between the source file and the OLE object, picture, or linked field. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - breakLink(): void; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.4] */ - load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the field's result data. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.4] */ - load(propertyNames?: string | string[]): Word.LinkFormat; + readonly result: Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the field's code instruction. * - * @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. + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LinkFormat; + code: string; /** - * 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. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] */ - track(): Word.LinkFormat; + data: string; /** - * 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. + * Gets the field's kind. + * + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.LinkFormat; + readonly kind: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LinkFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LinkFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] */ - toJSON(): Word.Interfaces.LinkFormatData; - } - /** - * Contains a collection of {@link Word.Paragraph} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class List 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; + locked: boolean; /** - * Gets paragraphs in the list. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly paragraphs: Word.ParagraphCollection; + showCodes: boolean; /** - * Gets the list's id. + * Gets the field's type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - readonly id: number; + readonly type: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * 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.FieldUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Field): void; + /** + * Copies the field to the Clipboard. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly levelExistences: boolean[]; + copyToClipboard(): void; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Removes the field from the document and places it on the Clipboard. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly levelTypes: Word.ListLevelType[]; + cut(): void; /** - * Gets the font of the bullet, number, or picture at the specified level in the list. + * Deletes the field. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level Required. The level in the list. + * [Api set: WordApi 1.5] */ - getLevelFont(level: number): Word.Font; + delete(): void; /** - * Gets the paragraphs that occur at the specified level in the list. + * Clicks the field. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLevelParagraphs(level: number): Word.ParagraphCollection; + doClick(): void; /** - * Gets the Base64-encoded string representation of the picture at the specified level in the list. + * Gets the next field. Throws an `ItemNotFound` error if this field is the last one. * * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level Required. The level in the list. + * [Api set: WordApi 1.4] */ - getLevelPicture(level: number): OfficeExtension.ClientResult; + getNext(): Word.Field; /** - * Gets the bullet, number, or picture at the specified level as a string. + * Gets the next field. If this field is the last one, 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] - * - * @param level Required. The level in the list. + * [Api set: WordApi 1.4] */ - getLevelString(level: number): OfficeExtension.ClientResult; + getNextOrNullObject(): Word.Field; /** - * Inserts a paragraph at the specified location. + * Selects the field. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; + select(selectionMode?: Word.SelectionMode): void; /** - * Resets the font of the bullet, number, or picture at the specified level in the list. + * Selects the field. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] * - * @param level Required. The level in the list. - * @param resetFontName Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - resetLevelFont(level: number, resetFontName?: boolean): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Replaces the field with its most recent result. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setLevelAlignment(level: number, alignment: Word.Alignment): void; + unlink(): void; /** - * Sets the alignment of the bullet, number, or picture at the specified level in the list. + * Updates the field. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. + * [Api set: WordApi 1.5] */ - setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; + updateResult(): void; /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. + * Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. - */ - setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; - /** - * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param listBullet Required. The bullet. - * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. - * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. - */ - setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; - /** - * Sets the two indents of the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. - * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. - */ - setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; - /** - * Sets the numbering format at the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. - */ - setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; - /** - * Sets the numbering format at the specified level in the list. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param listNumbering Required. The ordinal format. - * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. - */ - setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; - /** - * Sets the picture at the specified level in the list. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - * - * @param level Required. The level in the list. - * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. - */ - setLevelPicture(level: number, base64EncodedImage?: string): void; - /** - * Sets the starting number at the specified level in the list. Default value is 1. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param level Required. The level in the list. - * @param startingNumber Required. The number to start with. - */ - setLevelStartingNumber(level: number, startingNumber: number): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + updateSource(): 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.ListLoadOptions): Word.List; + load(options?: Word.Interfaces.FieldLoadOptions): Word.Field; /** * 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.List; + load(propertyNames?: string | string[]): Word.Field; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -109884,442 +109958,572 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.List; + }): Word.Field; /** * 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.List; + track(): Word.Field; /** * 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.List; + 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.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. + * 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.ListData; + toJSON(): Word.Interfaces.FieldData; } /** - * Contains a collection of {@link Word.List} objects. + * Contains a collection of {@link Word.Field} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. */ - class ListCollection extends OfficeExtension.ClientObject { + class FieldCollection 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.List[]; - /** - * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param id Required. A list identifier. - */ - getById(id: number): Word.List; - /** - * Gets a list by its identifier. If there isn't a list 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 1.3] - * - * @param id Required. A list identifier. - */ - getByIdOrNullObject(id: number): Word.List; + readonly items: Word.Field[]; /** - * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first field in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - getFirst(): Word.List; + getFirst(): Word.Field; /** - * Gets the first list 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}. + * Gets the first field 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 1.3] + * [Api set: WordApi 1.4] */ - getFirstOrNullObject(): Word.List; + getFirstOrNullObject(): Word.Field; /** - * Gets a list object by its ID. + * Gets the Field object collection including the specified types of fields. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] * - * @param id The list's ID. + * @param types Required. An array of field types. */ - getItem(id: number): Word.List; + getByTypes(types: Word.FieldType[]): Word.FieldCollection; /** * 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.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; + load(options?: Word.Interfaces.FieldCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FieldCollection; /** * 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.ListCollection; + load(propertyNames?: string | string[]): Word.FieldCollection; /** * 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.ListCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FieldCollection; /** * 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.ListCollection; + track(): Word.FieldCollection; /** * 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.ListCollection; + 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.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. + * 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.ListCollectionData; + toJSON(): Word.Interfaces.FieldCollectionData; } /** - * Represents the paragraph list item format. + * Represents a font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - class ListItem extends OfficeExtension.ClientObject { + class Font 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; /** - * Specifies the level of the item in the list. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level: number; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the list item bullet, number, or picture as a string. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listString: string; + readonly fill: Word.FillFormat; /** - * Gets the list item order number in relation to its siblings. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.3] - */ - readonly siblingIndex: 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListItem): void; + readonly glow: Word.GlowFormat; /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAncestor(parentOnly?: boolean): Word.Paragraph; + readonly line: Word.LineFormat; /** - * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, 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}. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks - * [Api set: WordApi 1.3] - * - * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; + readonly reflection: Word.ReflectionFormat; /** - * Gets all descendant list items of the list item. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApi 1.3] - * - * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; + readonly textColor: Word.ColorFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; + readonly textShadow: Word.ShadowFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListItem; + readonly threeDimensionalFormat: Word.ThreeDimensionalFormat; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * - * @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.ListItem; - /** - * 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.ListItem; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListItemData; - } - /** - * Represents a list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - class ListLevel 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; + allCaps: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - readonly font: Word.Font; + bold: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + boldBidirectional: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - linkedStyle: string; + color: string; /** - * Specifies the number format for the specified list level. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat: string; + colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition: number; + colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the number style for the list level object. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + contextualAlternates: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher: number; + diacriticColor: string; /** - * Specifies the starting number for the specified list level object. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt: number; + disableCharacterSpaceGrid: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - tabPosition: number; + doubleStrikeThrough: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition: number; + emboss: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListLevel): void; + emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; + engrave: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ListLevel; + hidden: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * - * @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.ListLevel; - /** - * 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.ListLevel; - /** - * 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.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. + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.ListLevelData; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - class ListLevelCollection 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.ListLevel[]; + highlightColor: string; /** - * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - getFirst(): Word.ListLevel; + italic: boolean; /** - * Gets the first list level 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}. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.ListLevel; + italicBidirectional: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; + kerning: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the ligature setting for the `Font` object. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListLevelCollection; + ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that represents the name of the font. * - * @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.ListLevelCollection; - /** - * 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. + * @remarks + * [Api set: WordApi 1.1] */ - track(): Word.ListLevelCollection; + name: string; /** - * 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. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ListLevelCollection; + nameAscii: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListLevelCollectionData; - } - /** - * Represents a list template. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - class ListTemplate 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; + nameBidirectional: string; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Specifies the East Asian font name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listLevels: Word.ListLevelCollection; + nameFarEast: string; /** - * Specifies the name of the list template. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name: string; + nameOther: string; /** - * Specifies whether the list template is outline numbered. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered: boolean; + numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * 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. + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor: string; + /** + * 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.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListTemplate): void; + set(properties: Word.Font): void; + /** + * Decreases the font size to the next available size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decreaseFontSize(): void; + /** + * Increases the font size to the next available size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + increaseFontSize(): void; + /** + * Removes manual character formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reset(): void; + /** + * Sets the specified font formatting as the default for the active document and all new documents based on the active template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setAsTemplateDefault(): 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.ListTemplateLoadOptions): Word.ListTemplate; + load(options?: Word.Interfaces.FontLoadOptions): Word.Font; /** * 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.ListTemplate; + load(propertyNames?: string | string[]): Word.Font; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -110328,92 +110532,75 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ListTemplate; + }): Word.Font; /** * 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.ListTemplate; + track(): Word.Font; /** * 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.ListTemplate; + 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.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. + * 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.ListTemplateData; + toJSON(): Word.Interfaces.FontData; } /** - * Represents a footnote or endnote. + * Represents a heading style used in a table of contents or table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class NoteItem extends OfficeExtension.ClientObject { + class HeadingStyle 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 note item. It's the portion of the text within the footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - readonly body: Word.Body; - /** - * Represents a footnote or endnote reference in the main document. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly reference: Word.Range; + level: number; /** - * Represents the note item type: footnote or endnote. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.NoteItemType | "Footnote" | "Endnote"; + name: string; /** * 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.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.NoteItem): void; + set(properties: Word.HeadingStyle): void; /** - * Deletes the note item. + * Deletes the heading style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ delete(): void; - /** - * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. - * - * @remarks - * [Api set: WordApi 1.5] - */ - getNext(): Word.NoteItem; - /** - * Gets the next note item of the same type. If this note item is the last one, 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.5] - */ - getNextOrNullObject(): Word.NoteItem; /** * 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.NoteItemLoadOptions): Word.NoteItem; + load(options?: Word.Interfaces.HeadingStyleLoadOptions): Word.HeadingStyle; /** * 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.NoteItem; + load(propertyNames?: string | string[]): Word.HeadingStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -110422,234 +110609,215 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.NoteItem; + }): Word.HeadingStyle; /** * 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.NoteItem; + track(): Word.HeadingStyle; /** * 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.NoteItem; + untrack(): Word.HeadingStyle; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.NoteItemData; + toJSON(): Word.Interfaces.HeadingStyleData; } /** - * Contains a collection of {@link Word.NoteItem} objects. + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class NoteItemCollection extends OfficeExtension.ClientObject { + class HeadingStyleCollection 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.NoteItem[]; + readonly items: Word.HeadingStyle[]; /** - * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Adds a new heading style to a document. * * @remarks - * [Api set: WordApi 1.5] - */ - getFirst(): Word.NoteItem; - /** - * Gets the first note item 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}. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.5] + * @param name The style name to be added. + * @param level The heading level to assign. Must be a value from 1 to 9. + * @returns The new `HeadingStyle` object that was added to the collection. */ - getFirstOrNullObject(): Word.NoteItem; + add(name: string, level: number): Word.HeadingStyle; /** * 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.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; + load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + load(propertyNames?: string | string[]): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + track(): Word.HeadingStyleCollection; /** * 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.NoteItemCollection; + untrack(): Word.HeadingStyleCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.NoteItemCollectionData; + toJSON(): Word.Interfaces.HeadingStyleCollectionData; } /** - * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * Represents a hyperlink in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class OleFormat extends OfficeExtension.ClientObject { + class Hyperlink 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; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType: string; + readonly range: Word.Range; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex: number; + address: string; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel: string; + emailSubject: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName: string; + readonly isExtraInfoRequired: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly iconPath: string; + readonly name: string; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isDisplayedAsIcon: boolean; + screenTip: string; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate: boolean; + subAddress: string; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly label: string; + target: string; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly progID: string; - /** - * 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.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.OleFormat): void; + textToDisplay: string; /** - * Activates the `OleFormat` object. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - activate(): void; + readonly type: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; /** - * Sets the Windows registry value that determines the default application used to activate the specified OLE object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param classType The class type to activate as. + * 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. */ - activateAs(classType: string): void; + set(properties: Interfaces.HyperlinkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Hyperlink): void; /** - * Requests that the OLE object perform one of its available verbs. + * Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param verbIndex Optional. The index of the verb to perform. */ - doVerb(verbIndex: Word.OleVerb): void; + addToFavorites(): void; /** - * Requests that the OLE object perform one of its available verbs. + * Creates a new document linked to the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param verbIndex Optional. The index of the verb to perform. - */ - doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; - /** - * Opens the OLE object for editing in the application it was created in. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param fileName Required. The name of the file. + * @param editNow Required. `true` to start editing now. + * @param overwrite Required. `true` to overwrite if there's another file with the same name. */ - edit(): void; + createNewDocument(fileName: string, editNow: boolean, overwrite: boolean): void; /** - * Opens the `OleFormat` object. + * Deletes the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - open(): void; + delete(): 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.OleFormatLoadOptions): Word.OleFormat; + load(options?: Word.Interfaces.HyperlinkLoadOptions): Word.Hyperlink; /** * 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.OleFormat; + load(propertyNames?: string | string[]): Word.Hyperlink; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -110658,1707 +110826,1655 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.OleFormat; + }): Word.Hyperlink; /** * 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.OleFormat; + track(): Word.Hyperlink; /** * 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.OleFormat; + untrack(): Word.Hyperlink; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.OleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.OleFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.OleFormatData; + toJSON(): Word.Interfaces.HyperlinkData; } /** - * Represents a page in the document. `Page` objects manage the page layout and content. + * Contains a collection of {@link Word.Hyperlink} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class Page extends OfficeExtension.ClientObject { + class HyperlinkCollection 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.Hyperlink[]; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly breaks: Word.BreakCollection; - /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly height: number; - /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly index: number; - /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly width: number; - /** - * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - getNext(): Word.Page; - /** - * Gets the next page. If this page is the last one, 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: WordApiDesktop 1.2] - */ - getNextOrNullObject(): Word.Page; - /** - * Gets the whole page, or the starting or ending point of the page, as a range. - * - * @remarks - * [Api set: WordApiDesktop 1.2] * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. + * @param anchor Required. The range to which the hyperlink is added. + * @param options Optional. The options to further configure the new hyperlink. */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + add(anchor: Word.Range, options?: Word.HyperlinkAddOptions): Word.Hyperlink; /** * 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.PageLoadOptions): Word.Page; + load(options?: Word.Interfaces.HyperlinkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HyperlinkCollection; /** * 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.Page; + load(propertyNames?: string | string[]): Word.HyperlinkCollection; /** * 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.Page; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HyperlinkCollection; /** * 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.Page; + track(): Word.HyperlinkCollection; /** * 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.Page; + untrack(): Word.HyperlinkCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.PageData; + toJSON(): Word.Interfaces.HyperlinkCollectionData; } /** - * Represents the collection of page. + * Specifies the options for adding to a {@link Word.HyperlinkCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class PageCollection 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.Page[]; + interface HyperlinkAddOptions { /** - * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies the address (e.g., URL or file path) of the hyperlink. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Page; + address?: string; /** - * Gets the first page 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}. + * If provided, specifies the text that appears as a tooltip. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Page; + screenTip?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the location within the file or document. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; + subAddress?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the name of the frame or window in which to load the hyperlink. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.PageCollection; + target?: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the visible text of the hyperlink. * - * @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.PageCollection; - /** - * 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.PageCollection; - /** - * 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.PageCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.PageCollectionData; + textToDisplay?: string; } /** - * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * Represents an inline picture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - class Pane extends OfficeExtension.ClientObject { + class InlinePicture 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 collection of pages in the pane. + * Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] */ - readonly pages: Word.PageCollection; + readonly paragraph: Word.Paragraph; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - readonly pagesEnclosingViewport: Word.PageCollection; + readonly parentContentControl: Word.ContentControl; /** - * Returns a `Selection` object that represents the current selection in the pane. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly selection: Word.Selection; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - getNext(): Word.Pane; + readonly parentTable: Word.Table; /** - * Gets the next pane. If this pane is the last one, 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}. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - getNextOrNullObject(): Word.Pane; + readonly parentTableCell: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.PaneLoadOptions): Word.Pane; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.Pane; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a string that represents the alternative text associated with the inline image. * - * @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.Pane; - /** - * 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.Pane; - /** - * 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.Pane; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.1] */ - toJSON(): Word.Interfaces.PaneData; - } - /** - * Represents the collection of pane. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class PaneCollection 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.Pane[]; + altTextDescription: string; /** - * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getFirst(): Word.Pane; + altTextTitle: string; /** - * Gets the first pane 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}. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - getFirstOrNullObject(): Word.Pane; + height: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(options?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; + hyperlink: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the format of the inline image. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.1] */ - load(propertyNames?: string | string[]): Word.PaneCollection; + readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * - * @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.PaneCollection; - /** - * 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. + * @remarks + * [Api set: WordApi 1.1] */ - track(): Word.PaneCollection; + lockAspectRatio: boolean; /** - * 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. + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.PaneCollection; + width: number; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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. */ - toJSON(): Word.Interfaces.PaneCollectionData; - } - /** - * The options that define whether to save changes before closing and whether to route the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface WindowCloseOptions { + set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.InlinePicture): void; /** - * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. + * Deletes the inline picture from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] */ - routeDocument?: boolean; + delete(): void; /** - * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. + * Gets the Base64-encoded string representation of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; - } - /** - * The options that scrolls a window or pane by the specified number of units defined by the calling method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface WindowScrollOptions { + getBase64ImageSrc(): OfficeExtension.ClientResult; /** - * If provided, specifies the number of units to scroll the window down. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. + * Gets the next inline image. Throws an `ItemNotFound` error if this inline image is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - down?: number; + getNext(): Word.InlinePicture; /** - * If provided, specifies the number of screens to scroll the window to the left. - If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. + * Gets the next inline image. If this inline image is the last one, 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 + * [Api set: WordApi 1.3] */ - left?: number; + getNextOrNullObject(): Word.InlinePicture; /** - * If provided, specifies the number of screens to scroll the window to the right. - If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. + * Gets the picture, or the starting or ending point of the picture, as a range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. */ - right?: number; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** - * If provided, specifies the number of units to scroll the window up. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. + * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param breakType Required. The break type to add. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - up?: number; - } - /** - * The options for scrolling through the specified pane or window page by page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface WindowPageScrollOptions { + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * If provided, specifies the number of pages to scroll the window down. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. + * Wraps the inline picture with a rich text content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - down?: number; + insertContentControl(): Word.ContentControl; /** - * If provided, specifies the number of pages to scroll the window up. - If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. + * Inserts a document at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * 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'. */ - up?: number; - } - /** - * Represents the window that displays the document. A window can be split to contain multiple reading panes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class Window 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; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the active pane in the window. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] + * + * @param html Required. The HTML to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - readonly activePane: Word.Pane; + insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the next document window in the collection of open document windows. + * Inserts an inline picture at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage Required. The Base64-encoded image to be inserted. + * @param insertLocation Required. The value must be 'Replace', 'Before', or 'After'. */ - readonly next: Word.Window; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture; /** - * Gets the collection of panes in the window. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.2] + * + * @param ooxml Required. The OOXML to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - readonly panes: Word.PaneCollection; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Gets the previous document window in the collection open document windows. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param paragraphText Required. The paragraph text to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - readonly previous: Word.Window; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Gets the `View` object that represents the view for the window. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param text Required. Text to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - readonly view: Word.View; + insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range; /** - * Specifies whether rulers are displayed for the window or pane. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - areRulersDisplayed: boolean; + select(selectionMode?: Word.SelectionMode): void; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Selects the inline picture. This causes Word to scroll to the selection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.2] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - readonly areScreenTipsDisplayed: boolean; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - areThumbnailsDisplayed: boolean; + load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - caption: string; + load(propertyNames?: string | string[]): Word.InlinePicture; /** - * Specifies the height of the window (in points). + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly height: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.InlinePicture; /** - * Specifies the horizontal scroll position as a percentage of the document width. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - horizontalPercentScrolled: number; + track(): Word.InlinePicture; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + untrack(): Word.InlinePicture; /** - * Gets the position of an item in a collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - readonly index: number; + toJSON(): Word.Interfaces.InlinePictureData; + } + /** + * Contains a collection of {@link Word.InlinePicture} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class InlinePictureCollection 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.InlinePicture[]; /** - * Specifies whether the window is active. + * Gets the first inline image in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isActive: boolean; + getFirst(): Word.InlinePicture; /** - * Specifies whether the document map is visible. + * Gets the first inline image 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 + * [Api set: WordApi 1.3] */ - isDocumentMapVisible: boolean; + getFirstOrNullObject(): Word.InlinePicture; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - isEnvelopeVisible: boolean; + load(options?: Word.Interfaces.InlinePictureCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.InlinePictureCollection; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - isHorizontalScrollBarDisplayed: boolean; + load(propertyNames?: string | string[]): Word.InlinePictureCollection; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isLeftScrollBarDisplayed: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.InlinePictureCollection; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - isRightRulerDisplayed: boolean; + track(): Word.InlinePictureCollection; /** - * Specifies whether the window is split into multiple panes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - isSplit: boolean; + untrack(): Word.InlinePictureCollection; /** - * Specifies whether a vertical ruler is displayed for the window or pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - isVerticalRulerDisplayed: boolean; + toJSON(): Word.Interfaces.InlinePictureCollectionData; + } + /** + * Represents the linking characteristics for an OLE object or picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class LinkFormat 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; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed: boolean; + isAutoUpdated: boolean; /** - * Specifies whether the window is visible. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + isLocked: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly left: number; + isPictureSavedWithDocument: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + sourceFullName: string; /** - * Specifies the vertical split percentage for the window. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical: number; + readonly sourceName: string; /** - * Specifies the width of the style area in points. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth: number; + readonly sourcePath: string; /** - * Specifies the vertical position of the document window, in points. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly top: number; + readonly type: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; /** - * Gets the window type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly type: Word.WindowType | "Document" | "Template"; + set(properties: Interfaces.LinkFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LinkFormat): void; /** - * Gets the height (in points) of the active working area in the document window. + * Breaks the link between the source file and the OLE object, picture, or linked field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly usableHeight: number; + breakLink(): void; /** - * Gets the width (in points) of the active working area in the document window. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly usableWidth: number; + load(options?: Word.Interfaces.LinkFormatLoadOptions): Word.LinkFormat; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - verticalPercentScrolled: number; + load(propertyNames?: string | string[]): Word.LinkFormat; /** - * Specifies the width of the document window, in points. + * 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.LinkFormat; + /** + * 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.LinkFormat; + /** + * 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.LinkFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LinkFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LinkFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LinkFormatData; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class List 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 paragraphs in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly width: number; + readonly paragraphs: Word.ParagraphCollection; /** - * Gets an integer that represents the position of the window. + * Gets the list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly windowNumber: number; + readonly id: number; /** - * Specifies the state of the document window or task window. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - windowState: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + readonly levelExistences: boolean[]; /** - * 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. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Window): void; + readonly levelTypes: Word.ListLevelType[]; /** - * Activates the window. + * Gets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] + * + * @param level Required. The level in the list. */ - activate(): void; + getLevelFont(level: number): Word.Font; /** - * Closes the window. + * Gets the paragraphs that occur at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param options The options that define whether to save changes before closing and whether to route the document. + * @param level Required. The level in the list. */ - close(options?: Word.WindowCloseOptions): void; + getLevelParagraphs(level: number): Word.ParagraphCollection; /** - * Scrolls the window by the specified number of screens. + * Gets the Base64-encoded string representation of the picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] * - * @param options The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. + * @param level Required. The level in the list. */ - largeScroll(options?: Word.WindowScrollOptions): void; + getLevelPicture(level: number): OfficeExtension.ClientResult; /** - * Scrolls through the window page by page. + * Gets the bullet, number, or picture at the specified level as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param options The options for scrolling through the window page by page. + * @param level Required. The level in the list. */ - pageScroll(options?: Word.WindowPageScrollOptions): void; + getLevelString(level: number): OfficeExtension.ClientResult; /** - * Sets the focus of the document window to the body of an email message. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param paragraphText Required. The paragraph text to be inserted. + * @param insertLocation Required. The value must be 'Start', 'End', 'Before', or 'After'. */ - setFocus(): void; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph; /** - * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. + * Resets the font of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] * - * @param options The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. + * @param level Required. The level in the list. + * @param resetFontName Optional. Indicates whether to reset the font name. Default is false that indicates the font name is kept unchanged. */ - smallScroll(options?: Word.WindowScrollOptions): void; + resetLevelFont(level: number, resetFontName?: boolean): void; /** - * Shows or hides the ribbon. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. */ - toggleRibbon(): void; + setLevelAlignment(level: number, alignment: Word.Alignment): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the alignment of the bullet, number, or picture at the specified level in the list. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param alignment Required. The level alignment that must be 'Left', 'Centered', or 'Right'. */ - load(options?: Word.Interfaces.WindowLoadOptions): Word.Window; + setLevelAlignment(level: number, alignment: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param listBullet Required. The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. */ - load(propertyNames?: string | string[]): Word.Window; + setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the bullet format at the specified level in the list. If the bullet is 'Custom', the charCode is required. * - * @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. + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param listBullet Required. The bullet. + * @param charCode Optional. The bullet character's code value. Used only if the bullet is 'Custom'. + * @param fontName Optional. The bullet's font name. Used only if the bullet is 'Custom'. */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Window; + setLevelBullet(level: number, listBullet: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void; /** - * 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. + * Sets the two indents of the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param textIndent Required. The text indent in points. It is the same as paragraph left indent. + * @param bulletNumberPictureIndent Required. The relative indent, in points, of the bullet, number, or picture. It is the same as paragraph first line indent. */ - track(): Word.Window; + setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void; /** - * 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. + * Sets the numbering format at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param listNumbering Required. The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - untrack(): Word.Window; + setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. + * Sets the numbering format at the specified level in the list. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param listNumbering Required. The ordinal format. + * @param formatString Optional. The numbering string format defined as an array of strings and/or integers. Each integer is a level of number type that is higher than or equal to this level. For example, an array of ["(", level - 1, ".", level, ")"] can define the format of "(2.c)", where 2 is the parent's item number and c is this level's item number. */ - toJSON(): Word.Interfaces.WindowData; - } - /** - * Represents the collection of window objects. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class WindowCollection 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.Window[]; + setLevelNumbering(level: number, listNumbering: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array): void; /** - * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Sets the picture at the specified level in the list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] + * + * @param level Required. The level in the list. + * @param base64EncodedImage Optional. The Base64-encoded image to be set. If not given, the default picture is set. */ - getFirst(): Word.Window; + setLevelPicture(level: number, base64EncodedImage?: string): void; /** - * Gets the first window 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}. + * Sets the starting number at the specified level in the list. Default value is 1. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param level Required. The level in the list. + * @param startingNumber Required. The number to start with. */ - getFirstOrNullObject(): Word.Window; + setLevelStartingNumber(level: number, startingNumber: number): 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.WindowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.WindowCollection; + load(options?: Word.Interfaces.ListLoadOptions): Word.List; /** * 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.WindowCollection; + load(propertyNames?: string | string[]): Word.List; /** * 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.WindowCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.List; /** * 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.WindowCollection; + track(): Word.List; /** * 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.WindowCollection; + 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.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.WindowCollectionData; + toJSON(): Word.Interfaces.ListData; } /** - * Represents a single paragraph in a selection, range, content control, or document body. + * Contains a collection of {@link Word.List} objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - class Paragraph extends OfficeExtension.ClientObject { + class ListCollection 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.List[]; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Gets a list by its identifier. Throws an `ItemNotFound` error if there isn't a list with the identifier in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param id Required. A list identifier. */ - readonly borders: Word.BorderUniversalCollection; + getById(id: number): Word.List; /** - * Gets the collection of content control objects in the paragraph. + * Gets a list by its identifier. If there isn't a list 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 1.1] + * [Api set: WordApi 1.3] + * + * @param id Required. A list identifier. */ - readonly contentControls: Word.ContentControlCollection; + getByIdOrNullObject(id: number): Word.List; /** - * Gets the collection of endnotes in the paragraph. + * Gets the first list in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - readonly endnotes: Word.NoteItemCollection; + getFirst(): Word.List; /** - * Gets the collection of fields in the paragraph. + * Gets the first list 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 1.4] + * [Api set: WordApi 1.3] */ - readonly fields: Word.FieldCollection; + getFirstOrNullObject(): Word.List; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Gets a list object by its ID. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] + * + * @param id The list's ID. */ - readonly font: Word.Font; + getItem(id: number): Word.List; /** - * Gets the collection of footnotes in the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.5] + * @param options Provides options for which properties of the object to load. */ - readonly footnotes: Word.NoteItemCollection; + load(options?: Word.Interfaces.ListCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListCollection; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly inlinePictures: Word.InlinePictureCollection; + load(propertyNames?: string | string[]): Word.ListCollection; /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - readonly list: Word.List; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListCollection; /** - * 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] + * 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. */ - readonly listItem: Word.ListItem; + track(): Word.ListCollection; /** - * 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}. + * 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.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. + */ + toJSON(): Word.Interfaces.ListCollectionData; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class ListItem 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; + /** + * Specifies the level of the item in the list. * * @remarks * [Api set: WordApi 1.3] */ - readonly listItemOrNullObject: Word.ListItem; + level: number; /** - * 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}. + * Gets the list item bullet, number, or picture as a string. * * @remarks * [Api set: WordApi 1.3] */ - readonly listOrNullObject: Word.List; + readonly listString: string; /** - * Gets the parent body of the paragraph. + * Gets the list item order number in relation to its siblings. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentBody: Word.Body; + readonly siblingIndex: number; /** - * 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] + * 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. */ - readonly parentContentControl: Word.ContentControl; + set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListItem): void; /** - * 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}. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. Throws an `ItemNotFound` error if the list item has no ancestor. * * @remarks * [Api set: WordApi 1.3] + * + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. */ - readonly parentContentControlOrNullObject: Word.ContentControl; + getAncestor(parentOnly?: boolean): Word.Paragraph; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the list item parent, or the closest ancestor if the parent doesn't exist. If the list item has no ancestor, 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] + * + * @param parentOnly Optional. Specifies only the list item's parent will be returned. The default is false that specifies to get the lowest ancestor. */ - readonly parentTable: Word.Table; + getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets all descendant list items of the list item. * * @remarks * [Api set: WordApi 1.3] + * + * @param directChildrenOnly Optional. Specifies only the list item's direct children will be returned. The default is false that indicates to get all descendant items. */ - readonly parentTableCell: Word.TableCell; + getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection; /** - * 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly parentTableCellOrNullObject: Word.TableCell; + load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem; /** - * 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly parentTableOrNullObject: Word.Table; + load(propertyNames?: string | string[]): Word.ListItem; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly shading: Word.ShadingUniversal; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListItem; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * 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.ListItem; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ListItemData; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListLevel 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 a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - readonly shapes: Word.ShapeCollection; + readonly font: Word.Font; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - firstLineIndent: number; + linkedStyle: string; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly isLastParagraph: boolean; + numberFormat: string; /** - * Checks whether the paragraph is a list item. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - readonly isListItem: boolean; + numberPosition: number; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - leftIndent: number; + numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineSpacing: number; + resetOnHigher: number; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineUnitAfter: number; + startAt: number; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - lineUnitBefore: number; + tabPosition: number; /** - * Specifies the outline level for the paragraph. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - outlineLevel: number; + textPosition: number; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - rightIndent: number; + trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; /** - * Specifies the spacing, in points, after the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] - */ - spaceAfter: number; - /** - * Specifies the spacing, in points, before the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - spaceBefore: number; + set(properties: Interfaces.ListLevelUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListLevel): void; /** - * Specifies the style name for the paragraph. 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. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param options Provides options for which properties of the object to load. */ - style: string; + load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + load(propertyNames?: string | string[]): Word.ListLevel; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - readonly tableNestingLevel: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListLevel; /** - * Gets the text of the paragraph. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - readonly text: string; + track(): Word.ListLevel; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. - * - * @remarks - * [Api set: WordApi 1.6] + * 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. */ - readonly uniqueLocalId: string; + untrack(): Word.ListLevel; /** - * 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. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Paragraph): void; + toJSON(): Word.Interfaces.ListLevelData; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListLevelCollection 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.ListLevel[]; /** - * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. + * Gets the first list level in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.3] - * - * @param listId Required. The ID of an existing list. - * @param level Required. The level in the list. + * [Api set: WordApiDesktop 1.1] */ - attachToList(listId: number, level: number): Word.List; + getFirst(): Word.ListLevel; /** - * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. + * Gets the first list level 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 1.1] + * [Api set: WordApiDesktop 1.1] */ - clear(): void; + getFirstOrNullObject(): Word.ListLevel; /** - * Removes any spacing before the paragraph. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - closeUp(): void; + load(options?: Word.Interfaces.ListLevelCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListLevelCollection; /** - * Deletes the paragraph and its content from the document. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - delete(): void; + load(propertyNames?: string | string[]): Word.ListLevelCollection; /** - * Moves this paragraph out of its list, if the paragraph is a list item. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - detachFromList(): void; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListLevelCollection; /** - * Gets annotations set on this Paragraph object. - * - * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. + * 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. */ - getAnnotations(): Word.AnnotationCollection; + track(): Word.ListLevelCollection; /** - * Gets comments associated with the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] + * 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. */ - getComments(): Word.CommentCollection; + untrack(): Word.ListLevelCollection; /** - * Gets the currently supported content controls in the paragraph. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. - * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. - * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. - * - * @param options Optional. Options that define which content controls are returned. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; + toJSON(): Word.Interfaces.ListLevelCollectionData; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + class ListTemplate 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 an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - getHtml(): OfficeExtension.ClientResult; + readonly listLevels: Word.ListLevelCollection; /** - * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNext(): Word.Paragraph; + name: string; /** - * Gets the next paragraph. If the paragraph is the last one, 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}. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - getNextOrNullObject(): Word.Paragraph; + outlineNumbered: boolean; /** - * Gets the Office Open XML (OOXML) representation of the paragraph object. - * - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - getOoxml(): OfficeExtension.ClientResult; + set(properties: Interfaces.ListTemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListTemplate): void; /** - * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - getPrevious(): Word.Paragraph; + load(options?: Word.Interfaces.ListTemplateLoadOptions): Word.ListTemplate; /** - * Gets the previous paragraph. If the paragraph is the first one, 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getPreviousOrNullObject(): Word.Paragraph; + load(propertyNames?: string | string[]): Word.ListTemplate; /** - * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. + * @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. */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListTemplate; /** - * Gets reviewed text based on ChangeTrackingVersion selection. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * 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. */ - getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; + track(): Word.ListTemplate; /** - * Gets reviewed text based on ChangeTrackingVersion selection. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. + * 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. */ - getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; + untrack(): Word.ListTemplate; /** - * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). - By default, hidden text and text marked as deleted are excluded. - * - * @remarks - * [Api set: WordApi 1.7] - * - * @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - getText(options?: Word.GetTextOptions | { - IncludeHiddenText?: boolean; - IncludeTextMarkedAsDeleted?: boolean; - }): OfficeExtension.ClientResult; + toJSON(): Word.Interfaces.ListTemplateData; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + class NoteItem 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 text ranges in the paragraph by using punctuation marks and/or other ending marks. + * 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.3] - * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * [Api set: WordApi 1.5] */ - getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; + readonly body: Word.Body; /** - * Gets the collection of the TrackedChange objects in the paragraph. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - getTrackedChanges(): Word.TrackedChangeCollection; + readonly reference: Word.Range; /** - * Indents the paragraph by one level. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - indent(): void; + readonly type: Word.NoteItemType | "Footnote" | "Endnote"; /** - * Indents the paragraph by a specified number of characters. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param count The number of characters for the indent. + * 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. */ - indentCharacterWidth(count: number): void; + set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.NoteItem): void; /** - * Indents the first line of the paragraph by the specified number of characters. + * Deletes the note item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param count The number of characters for the first line indent. + * [Api set: WordApi 1.5] */ - indentFirstLineCharacterWidth(count: number): void; + delete(): void; /** - * Inserts annotations on this Paragraph object. + * Gets the next note item of the same type. Throws an `ItemNotFound` error if this note item is the last one. * * @remarks - * [Api set: WordApi 1.7] - * - * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. - * - * @param annotations Annotations to set. - * @returns An array of the inserted annotations identifiers. + * [Api set: WordApi 1.5] */ - insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; + getNext(): Word.NoteItem; /** - * Inserts a break at the specified location in the main document. + * Gets the next note item of the same type. If this note item is the last one, 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.1] - * - * @param breakType Required. The break type to add to the document. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.5] */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + getNextOrNullObject(): Word.NoteItem; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). + * @param options Provides options for which properties of the object to load. */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem; /** - * Wraps the Paragraph object with a content control. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; + load(propertyNames?: string | string[]): Word.NoteItem; /** - * Inserts a document into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * 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. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64File Required. The Base64-encoded content of a .docx file. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * @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. */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.NoteItem; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * 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. */ - insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + track(): Word.NoteItem; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param geometricShapeType The geometric type of the shape to insert. - * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). + * 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. */ - insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + untrack(): Word.NoteItem; /** - * Inserts HTML into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param html Required. The HTML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. */ - insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + toJSON(): Word.Interfaces.NoteItemData; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + class NoteItemCollection 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.NoteItem[]; /** - * Inserts a picture into the paragraph at the specified location. + * Gets the first note item in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi 1.1] - * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * [Api set: WordApi 1.5] */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; + getFirst(): Word.NoteItem; /** - * Inserts OOXML into the paragraph at the specified location. + * Gets the first note item 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 1.1] - * - * @param ooxml Required. The OOXML to be inserted in the paragraph. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * [Api set: WordApi 1.5] */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + getFirstOrNullObject(): Word.NoteItem; /** - * Inserts a paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param options Provides options for which properties of the object to load. */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + load(options?: Word.Interfaces.NoteItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.NoteItemCollection; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + load(propertyNames?: string | string[]): Word.NoteItemCollection; /** - * Inserts a table with the specified number of rows and columns. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @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. */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.NoteItemCollection; /** - * Inserts text into the paragraph at the specified location. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. + * 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. */ - insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; + track(): Word.NoteItemCollection; /** - * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param text Optional. The text to insert into the text box. - * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). + * 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. */ - insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; + untrack(): Word.NoteItemCollection; /** - * Joins a list paragraph with the closest list above or below this 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.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; + } + /** + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class OleFormat 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; + /** + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - joinList(): void; + classType: string; /** - * Returns a `Paragraph` object that represents the next paragraph. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count Optional. The number of paragraphs to move forward. */ - next(count: number): Word.Paragraph; + iconIndex: number; /** - * Toggles the spacing before the paragraph. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openOrCloseUp(): void; + iconLabel: string; /** - * Sets spacing before the paragraph to 12 points. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openUp(): void; + iconName: string; /** - * Removes one level of indent for the paragraph. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outdent(): void; + readonly iconPath: string; /** - * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemote(): void; + readonly isDisplayedAsIcon: boolean; /** - * Demotes the paragraph to body text by applying the Normal style. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemoteToBody(): void; + isFormattingPreservedOnUpdate: boolean; /** - * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinePromote(): void; + readonly label: string; /** - * Returns the previous paragraph as a `Paragraph` object. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count Optional. The number of paragraphs to move backward. */ - previous(count: number): Word.Paragraph; + readonly progId: string; /** - * Removes manual paragraph formatting (formatting not applied using a style). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - reset(): void; + set(properties: Interfaces.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.OleFormat): void; /** - * Resets the paragraph that uses custom list levels to the original level settings. + * Activates the `OleFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resetAdvanceTo(): void; + activate(): void; /** - * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. + * Sets the Windows registry value that determines the default application used to activate the specified OLE object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param searchText Required. The search text. - * @param searchOptions Optional. Options for the search. + * @param classType The class type to activate as. */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + activateAs(classType: string): void; /** - * Selects and navigates the Word UI to the paragraph. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param verbIndex Optional. The index of the verb to perform. */ - select(selectionMode?: Word.SelectionMode): void; + doVerb(verbIndex: Word.OleVerb): void; /** - * Selects and navigates the Word UI to the paragraph. + * Requests that the OLE object perform one of its available verbs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @param verbIndex Optional. The index of the verb to perform. */ - select(selectionMode?: "Select" | "Start" | "End"): void; + doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void; /** - * Selects the number or bullet in a list. + * Opens the OLE object for editing in the application it was created in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectNumber(): void; + edit(): void; /** - * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. + * Opens the `OleFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateList(): void; + open(): void; /** - * Sets the paragraph to single spacing. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - space1(): void; + load(options?: Word.Interfaces.OleFormatLoadOptions): Word.OleFormat; /** - * Sets the paragraph to 1.5-line spacing. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - space1Pt5(): void; + load(propertyNames?: string | string[]): Word.OleFormat; /** - * Sets the paragraph to double spacing. + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * 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.OleFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.OleFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.OleFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.OleFormatData; + } + /** + * Represents a page in the document. `Page` objects manage the page layout and content. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Page 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 a `BreakCollection` object that represents the breaks on the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space2(): void; + readonly breaks: Word.BreakCollection; /** - * Splits the paragraph into child ranges by using delimiters. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + */ + readonly height: number; + /** + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * - * @param delimiters Required. The delimiters as an array of strings. - * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + readonly index: number; /** - * Starts a new list with this paragraph. Fails if the paragraph is already a list item. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - startNewList(): Word.List; + readonly width: number; /** - * Sets a hanging indent to a specified number of tab stops. + * Gets the next page in the pane. Throws an `ItemNotFound` error if this page is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + */ + getNext(): Word.Page; + /** + * Gets the next page. If this page is the last one, 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}. * - * @param count The number of tab stops for the hanging indent. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - tabHangingIndent(count: number): void; + getNextOrNullObject(): Word.Page; /** - * Sets the left indent for the paragraph to a specified number of tab stops. + * Gets the whole page, or the starting or ending point of the page, as a range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param count The number of tab stops for the left indent. + * @param rangeLocation Optional. The range location must be 'Whole', 'Start', or 'End'. */ - tabIndent(count: number): void; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** * 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.ParagraphLoadOptions): Word.Paragraph; + load(options?: Word.Interfaces.PageLoadOptions): Word.Page; /** * 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.Paragraph; + load(propertyNames?: string | string[]): Word.Page; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -112367,423 +112483,683 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Paragraph; + }): Word.Page; /** - * Occurs when new comments are added. + * 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.Page; + /** + * 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.Page; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Page` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PageData; + } + /** + * Represents the collection of page. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class PageCollection 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.Page[]; + /** + * Gets the first page in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * - * @eventproperty - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentAdded: OfficeExtension.EventHandlers; + getFirst(): Word.Page; /** - * Occurs when a comment or its reply is changed. + * Gets the first page 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)] + * [Api set: WordApiDesktop 1.2] + */ + getFirstOrNullObject(): Word.Page; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @eventproperty - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly onCommentChanged: OfficeExtension.EventHandlers; + load(options?: Word.Interfaces.PageCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PageCollection; /** - * Occurs when comments are deleted. + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * 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.PageCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.PageCollectionData; + } + /** + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Pane 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 collection of pages in the pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.2] + */ + readonly pages: Word.PageCollection; + /** + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. * - * @eventproperty - * @beta + * @remarks + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentDeleted: OfficeExtension.EventHandlers; + readonly pagesEnclosingViewport: Word.PageCollection; /** - * Occurs when a comment is deselected. + * Returns a `Selection` object that represents the current selection in the pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * - * @eventproperty * @beta */ - readonly onCommentDeselected: OfficeExtension.EventHandlers; + readonly selection: Word.Selection; /** - * Occurs when a comment is selected. + * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] + * [Api set: WordApiDesktop 1.2] + */ + getNext(): Word.Pane; + /** + * Gets the next pane. If this pane is the last one, 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}. * - * @eventproperty - * @beta + * @remarks + * [Api set: WordApiDesktop 1.2] */ - readonly onCommentSelected: OfficeExtension.EventHandlers; + getNextOrNullObject(): Word.Pane; + /** + * 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.PaneLoadOptions): Word.Pane; + /** + * 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.Pane; + /** + * 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.Pane; /** * 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.Paragraph; + track(): Word.Pane; /** * 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.Paragraph; + untrack(): Word.Pane; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.Pane` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphData; + toJSON(): Word.Interfaces.PaneData; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents the collection of pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - class ParagraphCollection extends OfficeExtension.ClientObject { + class PaneCollection 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.Paragraph[]; + readonly items: Word.Pane[]; /** - * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. + * Gets the first pane in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param range The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. + * [Api set: WordApiDesktop 1.2] */ - add(range: Word.Range): Word.Paragraph; + getFirst(): Word.Pane; /** - * Removes any spacing before the specified paragraphs. + * Gets the first pane 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 + * [Api set: WordApiDesktop 1.2] */ - closeUp(): void; + getFirstOrNullObject(): Word.Pane; /** - * Decreases the spacing before and after paragraphs in six-point increments. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - decreaseSpacing(): void; + load(options?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; /** - * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getFirst(): Word.Paragraph; + load(propertyNames?: string | string[]): Word.PaneCollection; /** - * Gets the first paragraph in this collection. If the 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}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getFirstOrNullObject(): Word.Paragraph; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.PaneCollection; /** - * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - getLast(): Word.Paragraph; + track(): Word.PaneCollection; /** - * Gets the last paragraph in this collection. If the 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}. + * 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.PaneCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PaneCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PaneCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.PaneCollectionData; + } + /** + * The options that define whether to save changes before closing and whether to route the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WindowCloseOptions { + /** + * If provided, specifies whether to route the document to the next recipient. If the document doesn't have a routing slip attached, this property is ignored. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getLastOrNullObject(): Word.Paragraph; + routeDocument?: boolean; /** - * Increases the spacing before and after paragraphs in six-point increments. + * If provided, specifies the save action for the document. For available values, see {@link Word.SaveConfiguration}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - increaseSpacing(): void; + saveChanges?: Word.SaveConfiguration | "DoNotSaveChanges" | "SaveChanges" | "PromptToSaveChanges"; + } + /** + * The options that scrolls a window or pane by the specified number of units defined by the calling method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WindowScrollOptions { /** - * Indents the paragraphs by one level. + * If provided, specifies the number of units to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent(): void; + down?: number; /** - * Indents the paragraphs in the collection by the specified number of characters. + * If provided, specifies the number of screens to scroll the window to the left. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count The number of characters by which the specified paragraphs are to be indented. */ - indentCharacterWidth(count: number): void; + left?: number; /** - * Indents the first line of the paragraphs in the collection by the specified number of characters. + * If provided, specifies the number of screens to scroll the window to the right. + If `left` and `right` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `left` is 3 and `right` is 6, the contents are scrolled to the right three screens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count The number of characters by which the first line of each specified paragraph is to be indented. */ - indentFirstLineCharacterWidth(count: number): void; + right?: number; /** - * Toggles spacing before paragraphs. + * If provided, specifies the number of units to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three units. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openOrCloseUp(): void; + up?: number; + } + /** + * The options for scrolling through the specified pane or window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WindowPageScrollOptions { /** - * Sets spacing before the specified paragraphs to 12 points. + * If provided, specifies the number of pages to scroll the window down. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - openUp(): void; + down?: number; /** - * Removes one level of indent for the paragraphs. + * If provided, specifies the number of pages to scroll the window up. + If `down` and `up` are both provided, the contents of the window are scrolled by the difference of the property values. For example, if `down` is 3 and `up` is 6, the contents are scrolled up three pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outdent(): void; + up?: number; + } + /** + * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Window 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; /** - * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. + * Gets the active pane in the window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + readonly activePane: Word.Pane; + /** + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemote(): void; + readonly next: Word.Window; /** - * Demotes the specified paragraphs to body text by applying the Normal style. + * Gets the collection of panes in the window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + readonly panes: Word.PaneCollection; + /** + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineDemoteToBody(): void; + readonly previous: Word.Window; /** - * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. + * Gets the `View` object that represents the view for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinePromote(): void; + readonly view: Word.View; /** - * Sets the specified paragraphs to single spacing. + * Specifies whether rulers are displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space1(): void; + areRulersDisplayed: boolean; /** - * Sets the specified paragraphs to 1.5-line spacing. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space1Pt5(): void; + readonly areScreenTipsDisplayed: boolean; /** - * Sets the specified paragraphs to double spacing. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - space2(): void; + areThumbnailsDisplayed: boolean; /** - * Sets a hanging indent to the specified number of tab stops. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - tabHangingIndent(count: number): void; + caption: string; /** - * Sets the left indent for the specified paragraphs to the specified number of tab stops. + * Specifies the height of the window (in points). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - tabIndent(count: number): void; + readonly height: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the horizontal scroll position as a percentage of the document width. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; + horizontalPercentScrolled: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ParagraphCollection; + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the position of an item in a collection. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; + readonly index: number; /** - * 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. + * Specifies whether the window is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ParagraphCollection; + readonly isActive: boolean; /** - * 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. + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ParagraphCollection; + isDocumentMapVisible: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies whether the email message header is visible in the document window. The default value is `False`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ParagraphCollectionData; - } - /** - * Represents a style of paragraph in a document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - class ParagraphFormat 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; + isEnvelopeVisible: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isHorizontalScrollBarDisplayed: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent: number; + isLeftScrollBarDisplayed: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether: boolean; + isRightRulerDisplayed: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext: boolean; + isSplit: boolean; /** - * Specifies the left indent. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent: number; + isVerticalRulerDisplayed: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing: number; + isVerticalScrollBarDisplayed: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter: number; + isVisible: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore: number; + readonly left: number; /** - * Specifies whether left and right indents are the same width. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents: boolean; + showSourceDocuments: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies the outline level for the specified paragraphs. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + splitVertical: number; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent: number; + styleAreaWidth: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter: number; + readonly top: number; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets the window type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore: number; + readonly type: Word.WindowType | "Document" | "Template"; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl: boolean; + readonly usableHeight: number; + /** + * Gets the width (in points) of the active working area in the document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly usableWidth: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled: number; + /** + * Specifies the width of the document window, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly width: number; + /** + * Gets an integer that represents the position of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly windowNumber: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState: Word.WindowState | "Normal" | "Maximize" | "Minimize"; /** * 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.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ParagraphFormat): void; + set(properties: Word.Window): void; + /** + * Activates the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + activate(): void; + /** + * Closes the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options that define whether to save changes before closing and whether to route the document. + */ + close(options?: Word.WindowCloseOptions): void; + /** + * Scrolls the window by the specified number of screens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for scrolling the window by the specified number of screens. If no options are specified, the window is scrolled down one screen. + */ + largeScroll(options?: Word.WindowScrollOptions): void; + /** + * Scrolls through the window page by page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for scrolling through the window page by page. + */ + pageScroll(options?: Word.WindowPageScrollOptions): void; + /** + * Sets the focus of the document window to the body of an email message. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setFocus(): void; + /** + * Scrolls the window by the specified number of lines. A "line" corresponds to the distance scrolled by clicking the scroll arrow on the scroll bar once. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for scrolling the window by the specified number of lines. If no options are specified, the window is scrolled down by one line. + */ + smallScroll(options?: Word.WindowScrollOptions): void; + /** + * Shows or hides the ribbon. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleRibbon(): 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.ParagraphFormatLoadOptions): Word.ParagraphFormat; + load(options?: Word.Interfaces.WindowLoadOptions): Word.Window; /** * 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.ParagraphFormat; + load(propertyNames?: string | string[]): Word.Window; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -112792,603 +113168,418 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ParagraphFormat; + }): Word.Window; /** * 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.ParagraphFormat; + track(): Word.Window; /** * 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.ParagraphFormat; + untrack(): Word.Window; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.Window` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ParagraphFormatData; + toJSON(): Word.Interfaces.WindowData; } /** - * Represents a contiguous area in a document. + * Represents the collection of window objects. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - class Range extends OfficeExtension.ClientObject { + class WindowCollection 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.Window[]; /** - * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. + * Gets the first window in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly bookmarks: Word.BookmarkCollection; + getFirst(): Word.Window; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Gets the first window 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 + * [Api set: WordApiDesktop 1.2] */ - readonly borders: Word.BorderUniversalCollection; + getFirstOrNullObject(): Word.Window; /** - * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly conflicts: Word.ConflictCollection; + load(options?: Word.Interfaces.WindowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.WindowCollection; /** - * Gets the collection of content control objects in the range. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.1] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly contentControls: Word.ContentControlCollection; + load(propertyNames?: string | string[]): Word.WindowCollection; /** - * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. + * 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.WindowCollection; + /** + * 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.WindowCollection; + /** + * 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.WindowCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WindowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WindowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.WindowCollectionData; + } + /** + * Represents a single paragraph in a selection, range, content control, or document body. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class Paragraph 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; + /** + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly editors: Word.EditorCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Gets the collection of endnotes in the range. + * Gets the collection of content control objects in the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + readonly contentControls: Word.ContentControlCollection; + /** + * Gets the collection of endnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly endnotes: Word.NoteItemCollection; /** - * Gets the collection of field objects in the range. + * Gets the collection of fields in the paragraph. * * @remarks * [Api set: WordApi 1.4] */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * 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] */ readonly font: Word.Font; /** - * Gets the collection of footnotes in the range. + * Gets the collection of footnotes in the paragraph. * * @remarks * [Api set: WordApi 1.5] */ readonly footnotes: Word.NoteItemCollection; /** - * Gets a `FrameCollection` object that represents all the frames in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly frames: Word.FrameCollection; - /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly hyperlinks: Word.HyperlinkCollection; - /** - * Gets the collection of inline picture objects in the range. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.1] */ readonly inlinePictures: Word.InlinePictureCollection; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly listFormat: Word.ListFormat; + readonly list: Word.List; /** - * Gets the collection of list objects in the range. + * 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] */ - readonly lists: Word.ListCollection; + readonly listItem: Word.ListItem; /** - * Gets the collection of pages in the range. + * 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly pages: Word.PageCollection; + readonly listItemOrNullObject: Word.ListItem; /** - * Gets the collection of paragraph objects in the range. + * 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.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * [Api set: WordApi 1.3] */ - readonly paragraphs: Word.ParagraphCollection; + readonly listOrNullObject: Word.List; /** - * Gets the parent body of the range. + * Gets the parent body of the paragraph. * * @remarks * [Api set: WordApi 1.3] */ readonly parentBody: Word.Body; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * 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] */ readonly parentContentControl: Word.ContentControl; /** - * 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}. + * 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] */ readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * 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] */ readonly parentTable: Word.Table; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * 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] */ readonly parentTableCell: Word.TableCell; /** - * 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}. + * 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] */ readonly parentTableCellOrNullObject: Word.TableCell; /** - * 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}. + * 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] */ readonly parentTableOrNullObject: Word.Table; /** - * Gets the collection of revisions that represents the tracked changes in the range. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly revisions: Word.RevisionCollection; + readonly shading: Word.ShadingUniversal; /** - * Gets the collection of sections in the range. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly sections: Word.SectionCollection; + readonly shapes: Word.ShapeCollection; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly shading: Word.ShadingUniversal; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - readonly shapes: Word.ShapeCollection; + firstLineIndent: number; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly tableColumns: Word.TableColumnCollection; + readonly isLastParagraph: boolean; /** - * Gets the collection of table objects in the range. + * Checks whether the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] */ - readonly tables: Word.TableCollection; + readonly isListItem: boolean; /** - * Specifies whether the range is formatted as bold. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly bold: boolean; + leftIndent: number; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly boldBidirectional: boolean; + lineSpacing: number; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + lineUnitAfter: number; /** - * Specifies the character width of the range. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - characterWidth: Word.CharacterWidth | "Half" | "Full"; + lineUnitBefore: number; /** - * Specifies if the range contains combined characters. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - combineCharacters: boolean; + outlineLevel: number; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly disableCharacterSpaceGrid: boolean; + rightIndent: number; /** - * Specifies the emphasis mark for a character or designated character string. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + spaceAfter: number; /** - * Specifies the ending character position of the range. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - end: number; + spaceBefore: number; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - fitTextWidth: number; - /** - * Specifies if a grammar check has been run on the range or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - grammarChecked: boolean; - /** - * Specifies the proofing status (spelling and grammar checking) of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hasNoProofing: boolean; - /** - * Specifies the highlight color for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; - /** - * Specifies the formatting for horizontal text set within vertical text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; - /** - * 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. - * - * @remarks - * [Api set: WordApi 1.3] - */ - hyperlink: string; - /** - * Specifies the ID for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - id: string; - /** - * Checks whether the range length is zero. - * - * @remarks - * [Api set: WordApi 1.3] - */ - readonly isEmpty: boolean; - /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isEndOfRowMark: boolean; - /** - * Gets whether the text in the range is visible on the screen. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly isTextVisibleOnScreen: boolean; - /** - * Specifies if the font or range is formatted as italic. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly italic: boolean; - /** - * Specifies if the font or range is formatted as italic (right-to-left languages). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly italicBidirectional: boolean; - /** - * Specifies whether the range of Japanese language text is hiragana or katakana. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - kana: Word.Kana | "Katakana" | "Hiragana"; - /** - * Specifies whether Microsoft Word has detected the language of the text in the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageDetected: boolean; - /** - * Specifies a `LanguageId` value that represents the language for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies an East Asian language for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies a language for the range that isn't classified as an East Asian language. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - showAll: boolean; - /** - * Specifies if spelling has been checked throughout the range or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spellingChecked: boolean; - /** - * Specifies the starting character position of the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - start: number; - /** - * Gets the number of characters in the story that contains the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly storyLength: number; - /** - * Gets the story type for the range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - /** - * Specifies the style name for the range. 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. + * Specifies the style name for the paragraph. 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. * * @remarks * [Api set: WordApi 1.1] */ style: string; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the text of the range. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - readonly text: string; + readonly tableNestingLevel: number; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + readonly text: string; /** - * Specifies the type of underline applied to the range. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - readonly underline: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + readonly uniqueLocalId: string; /** * 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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Range): void; - /** - * Clears the contents of the range object. The user can perform the undo operation on the cleared content. - * - * @remarks - * [Api set: WordApi 1.1] - */ - clear(): void; + set(properties: Word.Paragraph): void; /** - * Compares this range's location with another range's location. + * Lets the paragraph join an existing list at the specified level. Fails if the paragraph cannot join the list or if the paragraph is already a list item. * * @remarks * [Api set: WordApi 1.3] * - * @param range Required. The range to compare with this range. + * @param listId Required. The ID of an existing list. + * @param level Required. The level in the list. */ - compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; + attachToList(listId: number, level: number): Word.List; /** - * Deletes the range and its content from the document. + * Clears the contents of the paragraph object. The user can perform the undo operation on the cleared content. * * @remarks * [Api set: WordApi 1.1] */ - delete(): void; + clear(): void; /** - * Analyzes the range text to determine the language that it's written in. + * Removes any spacing before the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): OfficeExtension.ClientResult; + closeUp(): 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 don't have a union. + * Deletes the paragraph and its content from the document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param range Required. Another range. + * [Api set: WordApi 1.1] */ - expandTo(range: Word.Range): Word.Range; + delete(): void; /** - * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, 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}. + * Moves this paragraph out of its list, if the paragraph is a list item. * * @remarks * [Api set: WordApi 1.3] - * - * @param range Required. Another range. */ - expandToOrNullObject(range: Word.Range): Word.Range; + detachFromList(): void; /** - * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. + * Gets annotations set on this Paragraph object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] * - * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. - * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. */ - getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; + getAnnotations(): Word.AnnotationCollection; /** - * Gets comments associated with the range. + * Gets comments associated with the paragraph. * * @remarks * [Api set: WordApi 1.4] - * @returns */ getComments(): Word.CommentCollection; /** - * Gets the currently supported content controls in the range. + * Gets the currently supported content controls in the paragraph. * * @remarks * [Api set: WordApi 1.5] * - * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Important: If specific types are provided in the options parameter, only content controls of supported types are returned. * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. * @@ -113396,48 +113587,49 @@ declare namespace Word { */ getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. + * Gets an HTML representation of the paragraph object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Paragraph.getOoxml()` and convert the returned XML to HTML. * * @remarks * [Api set: WordApi 1.1] */ getHtml(): OfficeExtension.ClientResult; /** - * Gets hyperlink child ranges within the range. + * Gets the next paragraph. Throws an `ItemNotFound` error if the paragraph is the last one. * * @remarks * [Api set: WordApi 1.3] */ - getHyperlinkRanges(): Word.RangeCollection; + getNext(): Word.Paragraph; /** - * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. + * Gets the next paragraph. If the paragraph is the last one, 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] + */ + getNextOrNullObject(): Word.Paragraph; + /** + * Gets the Office Open XML (OOXML) representation of the paragraph object. * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. + * @remarks + * [Api set: WordApi 1.1] */ - getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; + getOoxml(): OfficeExtension.ClientResult; /** - * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, 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}. + * Gets the previous paragraph. Throws an `ItemNotFound` error if the paragraph is the first one. * * @remarks * [Api set: WordApi 1.3] - * - * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. - * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; + getPrevious(): Word.Paragraph; /** - * Gets the OOXML representation of the range object. + * Gets the previous paragraph. If the paragraph is the first one, 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.1] + * [Api set: WordApi 1.3] */ - getOoxml(): OfficeExtension.ClientResult; + getPreviousOrNullObject(): Word.Paragraph; /** - * Clones the range, or gets the starting or ending point of the range as a new range. + * Gets the whole paragraph, or the starting or ending point of the paragraph, as a range. * * @remarks * [Api set: WordApi 1.3] @@ -113464,7 +113656,20 @@ declare namespace Word { */ getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. + * Returns the text of the paragraph. This excludes equations, graphics (e.g., images, videos, drawings), and special characters that mark various content (e.g., for content controls, fields, comments, footnotes, endnotes). + By default, hidden text and text marked as deleted are excluded. + * + * @remarks + * [Api set: WordApi 1.7] + * + * @param options Optional. Options that define whether the final result should include hidden text and text marked as deleted. + */ + getText(options?: Word.GetTextOptions | { + IncludeHiddenText?: boolean; + IncludeTextMarkedAsDeleted?: boolean; + }): OfficeExtension.ClientResult; + /** + * Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks. * * @remarks * [Api set: WordApi 1.3] @@ -113474,113 +113679,85 @@ declare namespace Word { */ getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Gets the collection of the TrackedChange objects in the range. + * Gets the collection of the TrackedChange objects in the paragraph. * * @remarks * [Api set: WordApi 1.6] */ getTrackedChanges(): Word.TrackedChangeCollection; /** - * Highlights the range temporarily without changing document content. - To highlight the text permanently, set the range's Font.HighlightColor. + * Indents the paragraph by one level. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlight(): void; + indent(): void; /** - * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. + * Indents the paragraph by a specified number of characters. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. + * @param count The number of characters for the indent. */ - insertBookmark(name: string): void; + indentCharacterWidth(count: number): void; /** - * Inserts a break at the specified location in the main document. + * Indents the first line of the paragraph by the specified number of characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param breakType Required. The break type to add. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param count The number of characters for the first line indent. */ - insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; + indentFirstLineCharacterWidth(count: number): void; /** - * Inserts a floating canvas in front of text with its anchor at the beginning of the range. + * Inserts annotations on this Paragraph object. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). - */ - insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; - /** - * Insert a comment on the range. + * [Api set: WordApi 1.7] * - * @remarks - * [Api set: WordApi 1.4] + * Important: This API requires a Microsoft 365 subscription in order to work properly because of an underlying service's requirement. For more about this, see {@link https://github.com/OfficeDev/office-js/issues/4953 | GitHub issue 4953}. * - * @param commentText Required. The comment text to be inserted. - * @returns comment object + * @param annotations Annotations to set. + * @returns An array of the inserted annotations identifiers. */ - insertComment(commentText: string): Word.Comment; + insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult; /** - * Wraps the Range object with a content control. + * Inserts a break at the specified location in the main document. * * @remarks * [Api set: WordApi 1.1] * - * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. - * `DropDownList` and `ComboBox` support was added in WordApi 1.9. - * - * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. - */ - insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; - /** - * Inserts an endnote. The endnote reference is placed after the range. - * - * @remarks - * [Api set: WordApi 1.5] - * - * @param insertText Optional. Text to be inserted into the endnote body. The default is "". + * @param breakType Required. The break type to add to the document. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - insertEndnote(insertText?: string): Word.NoteItem; + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * Inserts a field at the specified location. + * Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph. * * @remarks - * [Api set: WordApi 1.5] - * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * [Api set: WordApiDesktop 1.2] * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. - * @param text Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * @param insertShapeOptions Optional. The location and size of canvas. The default location and size is (0, 0, 300, 200). */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts a field at the specified location. + * Wraps the Paragraph object with a content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] * - * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. - * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. * - * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. - * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. - * @param text Optional. Additional properties or options if needed for specified field type. - * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. + * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. */ - insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; /** - * Inserts a document at the specified location. + * Inserts a document into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] @@ -113588,20 +113765,11 @@ declare namespace Word { * 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'. - */ - insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; - /** - * Inserts a footnote. The footnote reference is placed after the range. - * - * @remarks - * [Api set: WordApi 1.5] - * - * @param insertText Optional. Text to be inserted into the footnote body. The default is "". + * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ - insertFootnote(insertText?: string): Word.NoteItem; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113611,7 +113779,7 @@ declare namespace Word { */ insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts a geometric shape in front of text with its anchor at the beginning of the range. + * Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113621,35 +113789,35 @@ declare namespace Word { */ insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Inserts HTML at the specified location. + * Inserts HTML into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * - * @param html Required. The HTML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param html Required. The HTML to be inserted in the paragraph. + * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ - insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a picture at the specified location. + * Inserts a picture into the paragraph at the specified location. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.1] * * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ - insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture; /** - * Inserts OOXML at the specified location. + * Inserts OOXML into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * - * @param ooxml Required. The OOXML to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param ooxml Required. The OOXML to be inserted in the paragraph. + * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ - insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** * Inserts a paragraph at the specified location. * @@ -113661,13 +113829,13 @@ declare namespace Word { */ insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Inserts a floating picture in front of text with its anchor at the beginning of the range. + * Inserts a floating picture in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] * * @param base64EncodedImage Required. The Base64-encoded image to be inserted. - * @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. + * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** @@ -113683,17 +113851,17 @@ declare namespace Word { */ insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Inserts text at the specified location. + * Inserts text into the paragraph at the specified location. * * @remarks * [Api set: WordApi 1.1] * * @param text Required. Text to be inserted. - * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'. */ - insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; + insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range; /** - * Inserts a floating text box in front of text with its anchor at the beginning of the range. + * Inserts a floating text box in front of text with its anchor at the beginning of the paragraph. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113703,90 +113871,223 @@ declare namespace Word { */ 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. + * Joins a list paragraph with the closest list above or below this paragraph. * * @remarks - * [Api set: WordApi 1.3] - * - * @param range Required. Another range. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - intersectWith(range: Word.Range): Word.Range; + joinList(): void; /** - * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, 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}. + * Returns a `Paragraph` object that represents the next paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param range Required. Another range. + * @param count Optional. The number of paragraphs to move forward. */ - intersectWithOrNullObject(range: Word.Range): Word.Range; + next(count: number): Word.Paragraph; /** - * Removes the highlight added by the Highlight function if any. + * Toggles the spacing before the paragraph. * * @remarks - * [Api set: WordApi 1.8] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeHighlight(): void; + openOrCloseUp(): void; /** - * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. + * Sets spacing before the paragraph to 12 points. * * @remarks - * [Api set: WordApi 1.1] - * - * @param searchText Required. The search text. - * @param searchOptions Optional. Options for the search. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + openUp(): void; /** - * Selects and navigates the Word UI to the range. + * Removes one level of indent for the paragraph. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: Word.SelectionMode): void; + outdent(): void; /** - * Selects and navigates the Word UI to the range. + * Applies the next heading level style (Heading 1 through Heading 8) to the paragraph. * * @remarks - * [Api set: WordApi 1.1] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. - */ + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineDemote(): void; + /** + * Demotes the paragraph to body text by applying the Normal style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineDemoteToBody(): void; + /** + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlinePromote(): void; + /** + * Returns the previous paragraph as a `Paragraph` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count Optional. The number of paragraphs to move backward. + */ + previous(count: number): Word.Paragraph; + /** + * Removes manual paragraph formatting (formatting not applied using a style). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reset(): void; + /** + * Resets the paragraph that uses custom list levels to the original level settings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resetAdvanceTo(): void; + /** + * Performs a search with the specified SearchOptions on the scope of the paragraph object. The search results are a collection of range objects. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param searchText Required. The search text. + * @param searchOptions Optional. Options for the search. + */ + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects and navigates the Word UI to the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Splits the range into child ranges by using delimiters. + * Selects the number or bullet in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectNumber(): void; + /** + * Separates a list into two separate lists. For numbered lists, the new list restarts numbering at the starting number, usually 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateList(): void; + /** + * Sets the paragraph to single spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1(): void; + /** + * Sets the paragraph to 1.5-line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space1Pt5(): void; + /** + * Sets the paragraph to double spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + space2(): void; + /** + * Splits the paragraph into child ranges by using delimiters. * * @remarks * [Api set: WordApi 1.3] * * @param delimiters Required. The delimiters as an array of strings. - * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; + /** + * Starts a new list with this paragraph. Fails if the paragraph is already a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + startNewList(): Word.List; + /** + * Sets a hanging indent to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops for the hanging indent. + */ + tabHangingIndent(count: number): void; + /** + * Sets the left indent for the paragraph to a specified number of tab stops. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops for the left indent. + */ + tabIndent(count: number): 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.RangeLoadOptions): Word.Range; + load(options?: Word.Interfaces.ParagraphLoadOptions): Word.Paragraph; /** * 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.Range; + load(propertyNames?: string | string[]): Word.Paragraph; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -113795,7 +114096,7 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Range; + }): Word.Paragraph; /** * Occurs when new comments are added. * @@ -113816,6 +114117,16 @@ declare namespace Word { * @beta */ readonly onCommentChanged: OfficeExtension.EventHandlers; + /** + * Occurs when comments are deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * + * @eventproperty + * @beta + */ + readonly onCommentDeleted: OfficeExtension.EventHandlers; /** * Occurs when a comment is deselected. * @@ -113839,462 +114150,369 @@ declare namespace Word { /** * 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.Range; + track(): Word.Paragraph; /** * 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.Range; + 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.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. + * 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.RangeData; + toJSON(): Word.Interfaces.ParagraphData; } /** - * Contains a collection of {@link Word.Range} objects. + * Contains a collection of {@link Word.Paragraph} objects. * * @remarks * [Api set: WordApi 1.1] */ - class RangeCollection extends OfficeExtension.ClientObject { + class ParagraphCollection 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.Range[]; - /** - * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.Range; + readonly items: Word.Paragraph[]; /** - * Gets the first range 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}. + * Returns a `Paragraph` object that represents a new, blank paragraph added to the document. * * @remarks - * [Api set: WordApi 1.3] - */ - getFirstOrNullObject(): Word.Range; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param options Provides options for which properties of the object to load. + * @param range The range before which you want the new paragraph to be added. The new paragraph doesn't replace the range. */ - load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; + add(range: Word.Range): Word.Paragraph; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Removes any spacing before the specified paragraphs. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RangeCollection; + closeUp(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Decreases the spacing before and after paragraphs in six-point increments. * - * @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.RangeCollection; - /** - * 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.RangeCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RangeCollectionData; - } - /** - * Specifies the options to determine location and size when inserting a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface InsertShapeOptions { + decreaseSpacing(): void; /** - * Represents the height of the shape being inserted. + * Gets the first paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height?: number; + getFirst(): Word.Paragraph; /** - * Represents the left position of the shape being inserted. + * Gets the first paragraph in this collection. If the 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - left?: number; + getFirstOrNullObject(): Word.Paragraph; /** - * Represents the top position of the shape being inserted. + * Gets the last paragraph in this collection. Throws an `ItemNotFound` error if the collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - top?: number; + getLast(): Word.Paragraph; /** - * Represents the width of the shape being inserted. + * Gets the last paragraph in this collection. If the 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - width?: number; - } - /** - * Specifies the options to determine what to copy when inserting a file. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface InsertFileOptions { + getLastOrNullObject(): Word.Paragraph; /** - * Represents whether the change tracking mode status from the source document should be imported. + * Increases the spacing before and after paragraphs in six-point increments. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importChangeTrackingMode?: boolean; + increaseSpacing(): void; /** - * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. + * Indents the paragraphs by one level. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importCustomProperties?: boolean; + indent(): void; /** - * Represents whether the custom XML parts from the source document should be imported. + * Indents the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters by which the specified paragraphs are to be indented. */ - importCustomXmlParts?: boolean; + indentCharacterWidth(count: number): void; /** - * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. + * Indents the first line of the paragraphs in the collection by the specified number of characters. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of characters by which the first line of each specified paragraph is to be indented. */ - importDifferentOddEvenPages?: boolean; + indentFirstLineCharacterWidth(count: number): void; /** - * Represents whether the page color and other background information from the source document should be imported. + * Toggles spacing before paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importPageColor?: boolean; + openOrCloseUp(): void; /** - * Represents whether the paragraph spacing from the source document should be imported. + * Sets spacing before the specified paragraphs to 12 points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importParagraphSpacing?: boolean; + openUp(): void; /** - * Represents whether the styles from the source document should be imported. + * Removes one level of indent for the paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importStyles?: boolean; + outdent(): void; /** - * Represents whether the theme from the source document should be imported. + * Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - importTheme?: boolean; - } - /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class SearchOptions 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; + outlineDemote(): void; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Demotes the specified paragraphs to body text by applying the Normal style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct: boolean; + outlineDemoteToBody(): void; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace: boolean; + outlinePromote(): void; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Sets the specified paragraphs to single spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase: boolean; + space1(): void; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Sets the specified paragraphs to 1.5-line spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix: boolean; + space1Pt5(): void; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Sets the specified paragraphs to double spacing. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix: boolean; + space2(): void; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Sets a hanging indent to the specified number of tab stops. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - matchWholeWord: boolean; + tabHangingIndent(count: number): void; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Sets the left indent for the specified paragraphs to the specified number of tab stops. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards: boolean; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param count The number of tab stops to indent (if positive) or the number of tab stops to remove from the indent (if negative). */ - set(properties: Interfaces.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.SearchOptions): void; + tabIndent(count: number): 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.SearchOptionsLoadOptions): Word.SearchOptions; + load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection; /** * 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.SearchOptions; + load(propertyNames?: string | string[]): Word.ParagraphCollection; /** * 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.SearchOptions; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection; /** - * Create a new instance of the `Word.SearchOptions` object. + * 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. */ - static newObject(context: OfficeExtension.ClientRequestContext): Word.SearchOptions; + track(): Word.ParagraphCollection; + /** + * 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.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.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. + * 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.SearchOptionsData; + toJSON(): Word.Interfaces.ParagraphCollectionData; } /** - * Specifies the options to be included in a getText operation. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - interface GetTextOptions { + class ParagraphFormat 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; /** - * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - includeHiddenText?: boolean; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] */ - includeTextMarkedAsDeleted?: boolean; - } - /** - * Specifies the options to be included in a compare document operation. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface DocumentCompareOptions { + firstLineIndent: number; /** - * True adds the document to the list of recently used files on the File menu. The default value is True. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - addToRecentFiles?: boolean; + keepTogether: boolean; /** - * The reviewer name associated with the differences generated by the comparison. - If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - authorName?: string; + keepWithNext: boolean; /** - * The target document for the comparison. Default value is 'CompareTargetCurrent'. + * Specifies the left indent. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; + leftIndent: number; /** - * True (default) for the comparison to include detection of format changes. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - detectFormatChanges?: boolean; + lineSpacing: number; /** - * True compares the documents without notifying a user of problems. The default value is False. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - ignoreAllComparisonWarnings?: boolean; + lineUnitAfter: number; /** - * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - removeDateAndTime?: boolean; + lineUnitBefore: number; /** - * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - removePersonalInformation?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - class Section 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; + mirrorIndents: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - readonly body: Word.Body; + outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly borders: Word.BorderUniversalCollection; - /** - * Returns a `PageSetup` object that's associated with the section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly pageSetup: Word.PageSetup; - /** - * Specifies if the section is protected for forms. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - protectedForForms: boolean; - /** - * 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.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Section): void; - /** - * Gets one of the section's footers. - * - * @remarks - * [Api set: WordApi 1.1] - * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. - */ - getFooter(type: Word.HeaderFooterType): Word.Body; - /** - * Gets one of the section's footers. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * [Api set: WordApi 1.5] */ - getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + rightIndent: number; /** - * Gets one of the section's headers. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * [Api set: WordApi 1.5] */ - getHeader(type: Word.HeaderFooterType): Word.Body; + spaceAfter: number; /** - * Gets one of the section's headers. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] - * - * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + * [Api set: WordApi 1.5] */ - getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + spaceBefore: number; /** - * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getNext(): Word.Section; + widowControl: boolean; /** - * Gets the next section. If this section is the last one, 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] + * 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. */ - getNextOrNullObject(): Word.Section; + set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ParagraphFormat): 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.SectionLoadOptions): Word.Section; + load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat; /** * 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.Section; + load(propertyNames?: string | string[]): Word.ParagraphFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -114303,1365 +114521,1300 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Section; + }): Word.ParagraphFormat; /** * 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.Section; + track(): Word.ParagraphFormat; /** * 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.Section; + 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.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. + * 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.SectionData; + toJSON(): Word.Interfaces.ParagraphFormatData; } /** - * Contains the collection of the document's {@link Word.Section} objects. + * Represents a contiguous area in a document. * * @remarks * [Api set: WordApi 1.1] */ - class SectionCollection extends OfficeExtension.ClientObject { + class Range 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.Section[]; /** - * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns a `BookmarkCollection` object that represents all the bookmarks in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Section; + readonly bookmarks: Word.BookmarkCollection; /** - * Gets the first section 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}. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Section; + readonly borders: Word.BorderUniversalCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; + readonly conflicts: Word.ConflictCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of content control objects in the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(propertyNames?: string | string[]): Word.SectionCollection; + readonly contentControls: Word.ContentControlCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. * - * @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.SectionCollection; - /** - * 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.SectionCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SectionCollectionData; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - class Setting 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; + readonly editors: Word.EditorCollection; /** - * Gets the key of the setting. + * Gets the collection of endnotes in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - readonly key: string; + readonly endnotes: Word.NoteItemCollection; /** - * Specifies the value of the setting. + * Gets the collection of field objects in the range. * * @remarks * [Api set: WordApi 1.4] */ - value: any; - /** - * 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.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Setting): void; + readonly fields: Word.FieldCollection; /** - * Deletes the setting. + * 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.4] + * [Api set: WordApi 1.1] */ - delete(): void; + readonly font: Word.Font; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of footnotes in the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting; + readonly footnotes: Word.NoteItemCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets a `FrameCollection` object that represents all the frames in the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Setting; + readonly frames: Word.FrameCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * - * @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.Setting; - /** - * 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.Setting; - /** - * 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.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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SettingData; - } - /** - * Contains the collection of {@link Word.Setting} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - class SettingCollection 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.Setting[]; + readonly hyperlinks: Word.HyperlinkCollection; /** - * Creates a new setting or sets an existing setting. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key Required. The setting's key, which is case-sensitive. - * @param value Required. The setting's value. + * [Api set: WordApi 1.2] */ - add(key: string, value: any): Word.Setting; + readonly inlinePictures: Word.InlinePictureCollection; /** - * Deletes all settings in this add-in. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteAll(): void; + readonly listFormat: Word.ListFormat; /** - * Gets the count of settings. + * Gets the collection of list objects in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - getCount(): OfficeExtension.ClientResult; + readonly lists: Word.ListCollection; /** - * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. + * Gets the collection of pages in the range. * * @remarks - * [Api set: WordApi 1.4] - * - * @param key The key that identifies the setting object. + * [Api set: WordApiDesktop 1.2] */ - getItem(key: string): Word.Setting; + readonly pages: Word.PageCollection; /** - * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, 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}. + * Gets the collection of paragraph objects in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] * - * @param key Required. The key that identifies the setting object. + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. */ - getItemOrNullObject(key: string): Word.Setting; + readonly paragraphs: Word.ParagraphCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the parent body of the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; + readonly parentBody: Word.Body; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(propertyNames?: string | string[]): Word.SettingCollection; + readonly parentContentControl: Word.ContentControl; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * 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}. * - * @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.SettingCollection; - /** - * 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.SettingCollection; - /** - * 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.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. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.SettingCollectionData; - } - /** - * Contains a collection of {@link Word.Style} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - class StyleCollection 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.Style[]; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * Get the style object by its name. + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.5] - * - * @param name Required. The style name. + * [Api set: WordApi 1.3] */ - getByName(name: string): Word.Style; + readonly parentTable: Word.Table; /** - * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. + * 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.5] - * - * @param name Required. The style name. + * [Api set: WordApi 1.3] */ - getByNameOrNullObject(name: string): Word.Style; + readonly parentTableCell: Word.TableCell; /** - * Gets the number of the styles 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.5] + * [Api set: WordApi 1.3] */ - getCount(): OfficeExtension.ClientResult; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * Gets a style object by its index 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.5] - * - * @param index A number that identifies the index location of a style object. + * [Api set: WordApi 1.3] */ - getItem(index: number): Word.Style; + readonly parentTableOrNullObject: Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of revisions that represents the tracked changes in the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; + readonly revisions: Word.RevisionCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of sections in the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.StyleCollection; + readonly sections: Word.SectionCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * - * @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.StyleCollection; - /** - * 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.StyleCollection; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.StyleCollection; + readonly shading: Word.ShadingUniversal; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.StyleCollectionData; - } - /** - * Represents a style in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class Style 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; + readonly shapes: Word.ShapeCollection; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly borders: Word.BorderCollection; + readonly tableColumns: Word.TableColumnCollection; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets the collection of table objects in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - readonly font: Word.Font; + readonly tables: Word.TableCollection; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly frame: Word.Frame; + readonly bold: boolean; /** - * Specifies a link between a paragraph and a character style. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle: Word.Style; + readonly boldBidirectional: boolean; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly listTemplate: Word.ListTemplate; + case: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly paragraphFormat: Word.ParagraphFormat; + characterWidth: Word.CharacterWidth | "Half" | "Full"; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly shading: Word.Shading; + combineCharacters: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly tableStyle: Word.TableStyle; + readonly disableCharacterSpaceGrid: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate: boolean; + readonly emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle: string; + end: number; /** - * Gets whether the specified style is a built-in style. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly builtIn: boolean; + fitTextWidth: number; /** - * Gets the description of the specified style. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly description: string; + grammarChecked: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing: boolean; + hasNoProofing: boolean; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly inUse: boolean; + readonly highlightColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + horizontalInVertical: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies an East Asian language for the style. + * 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. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink: string; + /** + * Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + id: string; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - readonly linked: boolean; + readonly isEmpty: boolean; /** - * Returns the list level for the style. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listLevelNumber: number; + readonly isEndOfRowMark: boolean; /** - * Specifies whether the style cannot be changed or edited. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked: boolean; + readonly isTextVisibleOnScreen: boolean; /** - * Gets the name of a style in the language of the user. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly nameLocal: string; + readonly italic: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nextParagraphStyle: string; + readonly italicBidirectional: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle: boolean; + kana: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the priority. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority: number; + languageDetected: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle: boolean; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the style type. + * Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed: boolean; + languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.5] - */ - visibility: boolean; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Style): void; + showAll: boolean; /** - * Deletes the style. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + spellingChecked: boolean; /** - * Links this style to a list template so that the style's formatting can be applied to lists. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate A `ListTemplate` to link to the style. */ - linkToListTemplate(listTemplate: Word.ListTemplate): void; + start: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the number of characters in the story that contains the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.StyleLoadOptions): Word.Style; + readonly storyLength: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the story type for the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Style; + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the style name for the range. 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. * - * @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.Style; - /** - * 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.Style; - /** - * 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. + * @remarks + * [Api set: WordApi 1.1] */ - untrack(): Word.Style; + style: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.StyleData; - } - /** - * Represents the shading object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - class Shading 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; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - backgroundPatternColor: string; + readonly text: string; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor: string; + twoLinesInOne: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the type of underline applied to the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + readonly underline: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; /** * 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.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shading): void; + set(properties: Word.Range): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Clears the contents of the range object. The user can perform the undo operation on the cleared content. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.1] */ - load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; + clear(): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Compares this range's location with another range's location. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.Shading; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.3] * - * @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.Shading; - /** - * 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.Shading; - /** - * 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.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. + * @param range Required. The range to compare with this range. */ - toJSON(): Word.Interfaces.ShadingData; - } - /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ShadingUniversal 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; + compareLocationWith(range: Word.Range): OfficeExtension.ClientResult; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Deletes the range and its content from the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - backgroundPatternColor: string; + delete(): void; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Analyzes the range text to determine the language that it's written in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + detectLanguage(): OfficeExtension.ClientResult; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * 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 BETA (PREVIEW ONLY)] - * @beta - */ - foregroundPatternColor: string; - /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * [Api set: WordApi 1.3] * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param range Required. Another range. */ - foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + expandTo(range: Word.Range): Word.Range; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Returns a new range that extends from this range in either direction to cover another range. This range isn't changed. If the two ranges don't have a union, 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 - */ - texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - /** - * 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.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadingUniversal): void; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * [Api set: WordApi 1.3] * - * @param options Provides options for which properties of the object to load. + * @param range Required. Another range. */ - load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; + expandToOrNullObject(range: Word.Range): Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the names all bookmarks in or overlapping the range. A bookmark is hidden if its name starts with the underscore character. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. - */ - load(propertyNames?: string | string[]): Word.ShadingUniversal; - /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * @remarks + * [Api set: WordApi 1.4] * - * @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.ShadingUniversal; - /** - * 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.ShadingUniversal; - /** - * 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.ShadingUniversal; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. + * @param includeHidden Optional. Indicates whether to include hidden bookmarks. Default is false which indicates that the hidden bookmarks are excluded. + * @param includeAdjacent Optional. Indicates whether to include bookmarks that are adjacent to the range. Default is false which indicates that the adjacent bookmarks are excluded. */ - toJSON(): Word.Interfaces.ShadingUniversalData; - } - /** - * Represents a table in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class Table 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; + getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult; /** - * Returns the `TableColumnCollection` object that represents the columns in the table. + * Gets comments associated with the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * @returns */ - readonly columns: Word.TableColumnCollection; + getComments(): Word.CommentCollection; /** - * Gets the collection of endnotes in the table. + * Gets the currently supported content controls in the range. * * @remarks * [Api set: WordApi 1.5] - */ - readonly endnotes: Word.NoteItemCollection; - /** - * Gets the collection of field objects in the table. * - * @remarks - * [Api set: WordApi 1.4] - */ - readonly fields: Word.FieldCollection; - /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * **Important**: If specific types are provided in the options parameter, only content controls of supported types are returned. + * Be aware that an exception will be thrown on using methods of a generic {@link Word.ContentControl} that aren't relevant for the specific type. + * With time, additional types of content controls may be supported. Therefore, your add-in should request and handle specific types of content controls. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Optional. Options that define which content controls are returned. */ - readonly font: Word.Font; + getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection; /** - * Gets the collection of footnotes in the table. + * Gets an HTML representation of the range object. When rendered in a web page or HTML viewer, the formatting will be a close, but not exact, match for of the formatting of the document. This method doesn't return the exact same HTML for the same document on different platforms (Windows, Mac, Word on the web, etc.). If you need exact fidelity, or consistency across platforms, use `Range.getOoxml()` and convert the returned XML to HTML. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - readonly footnotes: Word.NoteItemCollection; + getHtml(): OfficeExtension.ClientResult; /** - * Gets the parent body of the table. + * Gets hyperlink child ranges within the range. * * @remarks * [Api set: WordApi 1.3] */ - readonly parentBody: Word.Body; + getHyperlinkRanges(): Word.RangeCollection; /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the next text range by using punctuation marks and/or other ending marks. Throws an `ItemNotFound` error if this text range is the last one. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - readonly parentContentControl: Word.ContentControl; + getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * 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}. + * Gets the next text range by using punctuation marks and/or other ending marks. If this text range is the last one, 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] + * + * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the returned range. Default is false which indicates that spacing characters at the start and end of the range are included. */ - readonly parentContentControlOrNullObject: Word.ContentControl; + getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range; /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the OOXML representation of the range object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - readonly parentTable: Word.Table; + getOoxml(): OfficeExtension.ClientResult; /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Clones the range, or gets the starting or ending point of the range as a new range. * * @remarks * [Api set: WordApi 1.3] + * + * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', 'After', or 'Content'. */ - readonly parentTableCell: Word.TableCell; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range; /** - * 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}. + * Gets reviewed text based on ChangeTrackingVersion selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. */ - readonly parentTableCellOrNullObject: Word.TableCell; + getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult; /** - * 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}. + * Gets reviewed text based on ChangeTrackingVersion selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param changeTrackingVersion Optional. The value must be 'Original' or 'Current'. The default is 'Current'. */ - readonly parentTableOrNullObject: Word.Table; + getReviewedText(changeTrackingVersion?: "Original" | "Current"): OfficeExtension.ClientResult; /** - * Gets all of the table rows. + * Gets the text child ranges in the range by using punctuation marks and/or other ending marks. * * @remarks * [Api set: WordApi 1.3] + * + * @param endingMarks Required. The punctuation marks and/or other ending marks as an array of strings. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - readonly rows: Word.TableRowCollection; + getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection; /** - * Returns the `ShadingUniversal` object that represents the shading of the table. + * Gets the collection of the TrackedChange objects in the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - readonly shading: Word.ShadingUniversal; + getTrackedChanges(): Word.TrackedChangeCollection; /** - * Gets the child tables nested one level deeper. + * Highlights the range temporarily without changing document content. + To highlight the text permanently, set the range's Font.HighlightColor. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - readonly tables: Word.TableCollection; + highlight(): void; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Inserts a bookmark on the range. If a bookmark of the same name exists somewhere, it is deleted first. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The conditions of inserting a bookmark are similar to doing so in the Word UI. To learn more about managing bookmarks in the Word UI, see {@link https://support.microsoft.com/office/f68d781f-0150-4583-a90e-a4009d99c2a0 | Add or delete bookmarks in a Word document or Outlook message}. + * + * @param name Required. The case-insensitive bookmark name. Only alphanumeric and underscore characters are supported. It must begin with a letter but if you want to tag the bookmark as hidden, then start the name with an underscore character. Names can't be longer than 40 characters. */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + insertBookmark(name: string): void; /** - * Specifies the description of the table. + * Inserts a break at the specified location in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + * + * @param breakType Required. The break type to add. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - description: string; + insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void; /** - * Specifies the number of header rows. + * Inserts a floating canvas in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param insertShapeOptions Optional. The location and size of the canvas. The default location and size is (0, 0, 300, 200). */ - headerRowCount: number; + insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Insert a comment on the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * @param commentText Required. The comment text to be inserted. + * @returns comment object */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + insertComment(commentText: string): Word.Comment; /** - * Indicates whether all of the table rows are uniform. + * Wraps the Range object with a content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7. + * `DropDownList` and `ComboBox` support was added in WordApi 1.9. + * + * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'. The default is 'RichText'. */ - readonly isUniform: boolean; + insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * Inserts an endnote. The endnote reference is placed after the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param insertText Optional. Text to be inserted into the endnote body. The default is "". */ - readonly nestingLevel: number; + insertEndnote(insertText?: string): Word.NoteItem; /** - * Gets the number of rows in the table. + * Inserts a field at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param text Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - readonly rowCount: number; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Inserts a field at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Important: In Word on Windows and on Mac, the API supports inserting and managing all types listed in {@link Word.FieldType} except `Word.FieldType.others`. + * In Word on the web, fields are mainly read-only. To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/word/fields-guidance | Use fields in your Word add-in}. + * + * @param insertLocation Required. The location relative to the range where the field will be inserted. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. + * @param fieldType Optional. Can be any FieldType constant. The default value is Empty. + * @param text Optional. Additional properties or options if needed for specified field type. + * @param removeFormatting Optional. `true` to remove the formatting that's applied to the field during updates, `false` otherwise. The default value is `false`. */ - shadingColor: string; + insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field; /** - * Specifies the style name for the table. 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. + * Inserts a document at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * 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'. */ - style: string; + insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies whether the table has banded columns. + * Inserts a footnote. The footnote reference is placed after the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param insertText Optional. Text to be inserted into the footnote body. The default is "". */ - styleBandedColumns: boolean; + insertFootnote(insertText?: string): Word.NoteItem; /** - * Specifies whether the table has banded rows. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - styleBandedRows: boolean; + insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Inserts a geometric shape in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param geometricShapeType The geometric type of the shape to insert. + * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100). */ - styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies whether the table has a first column with a special style. + * Inserts HTML at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param html Required. The HTML to be inserted. + * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - styleFirstColumn: boolean; + insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies whether the table has a last column with a special style. + * Inserts a picture at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.2] + * + * @param base64EncodedImage Required. The Base64-encoded image to be inserted. + * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - styleLastColumn: boolean; + insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture; /** - * Specifies whether the table has a total (last) row with a special style. + * Inserts OOXML at the specified location. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param ooxml Required. The OOXML to be inserted. + * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - styleTotalRow: boolean; + insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Specifies the title of the table. + * Inserts a paragraph at the specified location. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + * + * @param paragraphText Required. The paragraph text to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. */ - title: string; + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Inserts a floating picture in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] + * + * @param base64EncodedImage Required. The Base64-encoded image to be inserted. + * @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size. */ - values: string[][]; + insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Inserts a table with the specified number of rows and columns. * * @remarks * [Api set: WordApi 1.3] + * + * @param rowCount Required. The number of rows in the table. + * @param columnCount Required. The number of columns in the table. + * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; /** - * Specifies the width of the table in points. + * Inserts text at the specified location. * * @remarks - * [Api set: WordApi 1.3] - */ - 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. + * [Api set: WordApi 1.1] + * + * @param text Required. Text to be inserted. + * @param insertLocation Required. The value must be 'Replace', 'Start', 'End', 'Before', or 'After'. */ - set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Table): void; + insertText(text: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range; /** - * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * Inserts a floating text box in front of text with its anchor at the beginning of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] * - * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. - * @param columnCount Required. Number of columns to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param text Optional. The text to insert into the text box. + * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100). */ - addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; + insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape; /** - * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * 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. * * @remarks * [Api set: WordApi 1.3] * - * @param insertLocation Required. It must be 'Start' or 'End'. - * @param rowCount Required. Number of rows to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * @param range Required. Another range. */ - addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + intersectWith(range: Word.Range): Word.Range; /** - * Applies the specified style but maintains any formatting that a user directly applies. + * Returns a new range as the intersection of this range with another range. This range isn't changed. If the two ranges aren't overlapped or adjacent, 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 + * [Api set: WordApi 1.3] * - * @param styleName The name of the style to apply. + * @param range Required. Another range. */ - applyStyleDirectFormatting(styleName: string): void; + intersectWithOrNullObject(range: Word.Range): Word.Range; /** - * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * Removes the highlight added by the Highlight function if any. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param behavior How Word resizes the specified table with the AutoFit feature is used. + * [Api set: WordApi 1.8] */ - autoFitBehavior(behavior: Word.AutoFitBehavior): void; + removeHighlight(): void; /** - * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * Performs a search with the specified SearchOptions on the scope of the range object. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param behavior How Word resizes the specified table with the AutoFit feature is used. + * @param searchText Required. The search text. + * @param searchOptions Optional. Options for the search. */ - autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Autofits the table columns to the width of the window. + * Selects and navigates the Word UI to the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - autoFitWindow(): void; + select(selectionMode?: Word.SelectionMode): void; /** - * Applies a predefined look to a table. + * Selects and navigates the Word UI to the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param options Optional. An object that specifies the options for applying the table format. + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - autoFormat(options?: Word.TableAutoFormatOptions): void; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Clears the contents of the table. + * Splits the range into child ranges by using delimiters. * * @remarks * [Api set: WordApi 1.3] + * + * @param delimiters Required. The delimiters as an array of strings. + * @param multiParagraphs Optional. Indicates whether a returned child range can cover multiple paragraphs. Default is false which indicates that the paragraph boundaries are also used as delimiters. + * @param trimDelimiters Optional. Indicates whether to trim delimiters from the ranges in the range collection. Default is false which indicates that the delimiters are included in the ranges returned in the range collection. + * @param trimSpacing Optional. Indicates whether to trim spacing characters (spaces, tabs, column breaks, and paragraph end marks) from the start and end of the ranges returned in the range collection. Default is false which indicates that spacing characters at the start and end of the ranges are included in the range collection. */ - clear(): void; + split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection; /** - * Converts a table to text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param options An object that specifies the options for converting the table to text. - * @returns A `Range` object that represents the converted text. + * @param options Provides options for which properties of the object to load. */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; + load(options?: Word.Interfaces.RangeLoadOptions): Word.Range; /** - * Deletes the entire table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - delete(): void; + load(propertyNames?: string | string[]): Word.Range; /** - * Deletes specific columns. This is applicable to uniform tables. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param columnIndex Required. The first column to delete. - * @param columnCount Optional. The number of columns to delete. Default 1. + * @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. */ - deleteColumns(columnIndex: number, columnCount?: number): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Range; /** - * Deletes specific rows. + * Occurs when new comments are added. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param rowIndex Required. The first row to delete. - * @param rowCount Optional. The number of rows to delete. Default 1. + * @eventproperty + * @beta */ - deleteRows(rowIndex: number, rowCount?: number): void; + readonly onCommentAdded: OfficeExtension.EventHandlers; /** - * Distributes the column widths evenly. This is applicable to uniform tables. + * Occurs when a comment or its reply is changed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * + * @eventproperty + * @beta */ - distributeColumns(): void; + readonly onCommentChanged: OfficeExtension.EventHandlers; /** - * Gets the border style for the specified border. + * Occurs when a comment is deselected. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param borderLocation Required. The border location. + * @eventproperty + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + readonly onCommentDeselected: OfficeExtension.EventHandlers; /** - * Gets the border style for the specified border. + * Occurs when a comment is selected. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] * - * @param borderLocation Required. The border location. + * @eventproperty + * @beta */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + readonly onCommentSelected: OfficeExtension.EventHandlers; /** - * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. + * 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.Range; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeData; + } + /** + * Contains a collection of {@link Word.Range} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class RangeCollection 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.Range[]; + /** + * Gets the first range in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks * [Api set: WordApi 1.3] - * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. */ - getCell(rowIndex: number, cellIndex: number): Word.TableCell; + getFirst(): Word.Range; /** - * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, 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}. + * Gets the first range 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 1.3] + */ + getFirstOrNullObject(): Word.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param rowIndex Required. The index of the row. - * @param cellIndex Required. The index of the cell in the row. + * @param options Provides options for which properties of the object to load. */ - getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; + load(options?: Word.Interfaces.RangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeCollection; /** - * Gets cell padding in points. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.RangeCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @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. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeCollection; /** - * Gets cell padding in points. + * 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.RangeCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.RangeCollectionData; + } + /** + * Specifies the options to determine location and size when inserting a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface InsertShapeOptions { + /** + * Represents the height of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * [Api set: WordApiDesktop 1.2] */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + height?: number; /** - * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. + * Represents the left position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getNext(): Word.Table; + left?: number; /** - * Gets the next table. If this table is the last one, 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}. + * Represents the top position of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getNextOrNullObject(): Word.Table; + top?: number; /** - * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * Represents the width of the shape being inserted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - getParagraphAfter(): Word.Paragraph; + width?: number; + } + /** + * Specifies the options to determine what to copy when inserting a file. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface InsertFileOptions { /** - * Gets the paragraph after the table. If there isn't a paragraph after the 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}. + * Represents whether the change tracking mode status from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getParagraphAfterOrNullObject(): Word.Paragraph; + importChangeTrackingMode?: boolean; /** - * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * Represents whether the custom properties from the source document should be imported. Overwrites existing properties with the same name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - getParagraphBefore(): Word.Paragraph; + importCustomProperties?: boolean; /** - * Gets the paragraph before the table. If there isn't a paragraph before the 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}. + * Represents whether the custom XML parts from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - getParagraphBeforeOrNullObject(): Word.Paragraph; + importCustomXmlParts?: boolean; /** - * Gets the range that contains this table, or the range at the start or end of the table. + * Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + * [Api set: WordApi 1.7] */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + importDifferentOddEvenPages?: boolean; /** - * Inserts a content control on the table. + * Represents whether the page color and other background information from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - insertContentControl(): Word.ContentControl; + importPageColor?: boolean; /** - * Inserts a paragraph at the specified location. + * Represents whether the paragraph spacing from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param paragraphText Required. The paragraph text to be inserted. - * @param insertLocation Required. The value must be 'Before' or 'After'. + * [Api set: WordApi 1.5] */ - insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + importParagraphSpacing?: boolean; /** - * Inserts a table with the specified number of rows and columns. + * Represents whether the styles from the source document should be imported. * * @remarks - * [Api set: WordApi 1.3] - * - * @param rowCount Required. The number of rows in the table. - * @param columnCount Required. The number of columns in the table. - * @param insertLocation Required. The value must be 'Before' or 'After'. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * [Api set: WordApi 1.5] */ - insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + importStyles?: boolean; /** - * Merges the cells bounded inclusively by a first and last cell. + * Represents whether the theme from the source document should be imported. * * @remarks - * [Api set: WordApi 1.4] - * - * @param topRow Required. The row of the first cell - * @param firstCell Required. The index of the first cell in its row - * @param bottomRow Required. The row of the last cell - * @param lastCell Required. The index of the last cell in its row + * [Api set: WordApi 1.5] */ - mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + importTheme?: boolean; + } + /** + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class SearchOptions 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; /** - * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - reapplyAutoFormat(): void; + ignorePunct: boolean; /** - * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param searchText Required. The search text. - * @param searchOptions Optional. Options for the search. + * [Api set: WordApi 1.1] */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + ignoreSpace: boolean; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi 1.1] */ - select(selectionMode?: Word.SelectionMode): void; + matchCase: boolean; /** - * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi 1.1] */ - select(selectionMode?: "Select" | "Start" | "End"): void; + matchPrefix: boolean; /** - * Sets cell padding in points. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * [Api set: WordApi 1.1] */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + matchSuffix: boolean; /** - * Sets cell padding in points. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * [Api set: WordApi 1.1] */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + matchWholeWord: boolean; /** - * Sorts the specified table. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options An object that specifies the options for sorting the table. + * [Api set: WordApi 1.1] */ - sort(options?: Word.TableSortOptions): void; + matchWildcards: boolean; + /** + * 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.SearchOptionsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.SearchOptions): 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.TableLoadOptions): Word.Table; + load(options?: Word.Interfaces.SearchOptionsLoadOptions): Word.SearchOptions; /** * 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.Table; + load(propertyNames?: string | string[]): Word.SearchOptions; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115670,175 +115823,207 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Table; - /** - * 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.Table; + }): Word.SearchOptions; /** - * 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. + * Create a new instance of the `Word.SearchOptions` object. */ - untrack(): Word.Table; + 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.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. + * 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.TableData; + toJSON(): Word.Interfaces.SearchOptionsData; } /** - * Represents the TableStyle object. + * Specifies the options to be included in a getText operation. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.7] */ - class TableStyle 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; + interface GetTextOptions { /** - * Returns a `BorderUniversalCollection` that represents all the borders for the table. + * Specifies a value that indicates whether to include hidden text in the result of the GetText method. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - readonly borders: Word.BorderUniversalCollection; + includeHiddenText?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. + * Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - readonly shading: Word.Shading; + includeTextMarkedAsDeleted?: boolean; + } + /** + * Specifies the options to be included in a compare document operation. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface DocumentCompareOptions { /** - * Specifies the table's alignment against the page margin. + * True adds the document to the list of recently used files on the File menu. The default value is True. * * @remarks * [Api set: WordApiDesktop 1.1] */ - alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + addToRecentFiles?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * The reviewer name associated with the differences generated by the comparison. + If unspecified, the value defaults to the author name of the revised document or the string "Comparison" if no author information is present. * * @remarks * [Api set: WordApiDesktop 1.1] */ - allowBreakAcrossPage: boolean; - /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. - * - * @remarks - * [Api set: WordApi 1.6] - */ - bottomCellMargin: number; + authorName?: string; /** - * Specifies the spacing (in points) between the cells in a table style. + * The target document for the comparison. Default value is 'CompareTargetCurrent'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - cellSpacing: number; + compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * True (default) for the comparison to include detection of format changes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - columnStripe: number; + detectFormatChanges?: boolean; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * True compares the documents without notifying a user of problems. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isBreakAcrossPagesAllowed: boolean; + ignoreAllComparisonWarnings?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * True removes date and time stamp information from tracked changes in the returned Document object. The default value is False. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.1] */ - leftCellMargin: number; + removeDateAndTime?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * True removes all user information from comments, revisions, and the properties dialog box in the returned Document object. The default value is False. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - leftIndent: number; + removePersonalInformation?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + class Section 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; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.1] */ - rightCellMargin: number; + readonly body: Word.Body; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe: number; + readonly borders: Word.BorderUniversalCollection; /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; + readonly pageSetup: Word.PageSetup; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin: number; + protectedForForms: boolean; /** * 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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.SectionUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableStyle): void; + set(properties: Word.Section): void; /** - * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param conditionCode The area of the table to which to apply the formatting. + * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. */ - condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; + getFooter(type: Word.HeaderFooterType): Word.Body; /** - * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * Gets one of the section's footers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] * - * @param conditionCode The area of the table to which to apply the formatting. + * @param type Required. The type of footer to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. */ - condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; + getFooter(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: Word.HeaderFooterType): Word.Body; + /** + * Gets one of the section's headers. + * + * @remarks + * [Api set: WordApi 1.1] + * + * @param type Required. The type of header to return. This value must be: 'Primary', 'FirstPage', or 'EvenPages'. + */ + getHeader(type: "Primary" | "FirstPage" | "EvenPages"): Word.Body; + /** + * Gets the next section. Throws an `ItemNotFound` error if this section is the last one. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getNext(): Word.Section; + /** + * Gets the next section. If this section is the last one, 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] + */ + getNextOrNullObject(): Word.Section; /** * 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.TableStyleLoadOptions): Word.TableStyle; + load(options?: Word.Interfaces.SectionLoadOptions): Word.Section; /** * 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.TableStyle; + load(propertyNames?: string | string[]): Word.Section; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115847,99 +116032,128 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableStyle; + }): Word.Section; /** * 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.TableStyle; + track(): Word.Section; /** * 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.TableStyle; + 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.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. + * 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.TableStyleData; + toJSON(): Word.Interfaces.SectionData; } /** - * Represents a tab stop in a Word document. + * Contains the collection of the document's {@link Word.Section} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - class TabStop extends OfficeExtension.ClientObject { + class SectionCollection 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.Section[]; /** - * Gets the next tab stop in the collection. + * Gets the first section in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly next: Word.TabStop; + getFirst(): Word.Section; /** - * Gets the previous tab stop in the collection. + * Gets the first section 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 + * [Api set: WordApi 1.3] */ - readonly previous: Word.TabStop; + getFirstOrNullObject(): Word.Section; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + load(options?: Word.Interfaces.SectionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SectionCollection; /** - * Gets whether this tab stop is a custom tab stop. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly customTab: boolean; + load(propertyNames?: string | string[]): Word.SectionCollection; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * 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.SectionCollection; + /** + * 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.SectionCollection; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.SectionCollectionData; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + class Setting 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + readonly key: string; /** - * Gets the position of the tab stop relative to the left margin. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly position: number; + value: any; /** - * Removes this custom tab stop. + * 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.SettingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Setting): void; + /** + * Deletes the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - clear(): void; + delete(): 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.TabStopLoadOptions): Word.TabStop; + load(options?: Word.Interfaces.SettingLoadOptions): Word.Setting; /** * 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.TabStop; + load(propertyNames?: string | string[]): Word.Setting; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115948,620 +116162,598 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TabStop; + }): Word.Setting; /** * 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.TabStop; + track(): Word.Setting; /** * 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.TabStop; + 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.TabStop` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopData`) that contains shallow copies of any loaded child properties from the original object. + * 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.TabStopData; + toJSON(): Word.Interfaces.SettingData; } /** - * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * Contains the collection of {@link Word.Setting} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - class TabStopCollection extends OfficeExtension.ClientObject { + class SettingCollection 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.TabStop[]; + readonly items: Word.Setting[]; /** - * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. + * Creates a new setting or sets an existing setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] * - * @param position The position of the tab stop. - * @param options Optional. The options to further configure the new tab stop. + * @param key Required. The setting's key, which is case-sensitive. + * @param value Required. The setting's value. */ - add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; + add(key: string, value: any): Word.Setting; /** - * Returns the next `TabStop` object to the right of the specified position. + * Deletes all settings in this add-in. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param Position The position to check. + * [Api set: WordApi 1.4] */ - after(Position: number): Word.TabStop; + deleteAll(): void; /** - * Returns the next `TabStop` object to the left of the specified position. + * Gets the count of settings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param Position The position to check. + * [Api set: WordApi 1.4] */ - before(Position: number): Word.TabStop; + getCount(): OfficeExtension.ClientResult; /** - * Clears all the custom tab stops from the paragraph. + * Gets a setting object by its key, which is case-sensitive. Throws an `ItemNotFound` error if the setting doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * @param key The key that identifies the setting object. */ - clearAll(): void; + getItem(key: string): Word.Setting; /** - * Gets a `TabStop` object by its index in the collection. + * Gets a setting object by its key, which is case-sensitive. If the setting doesn't exist, 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 + * [Api set: WordApi 1.4] * - * @param index A number that identifies the index location of a `TabStop` object. + * @param key Required. The key that identifies the setting object. */ - getItem(index: number): Word.TabStop; + getItemOrNullObject(key: string): Word.Setting; /** * 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.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; + load(options?: Word.Interfaces.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection; /** * 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.TabStopCollection; + load(propertyNames?: string | string[]): Word.SettingCollection; /** * 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.TabStopCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SettingCollection; /** * 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.TabStopCollection; + track(): Word.SettingCollection; /** * 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.TabStopCollection; + 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.TabStopCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TabStopCollectionData; + toJSON(): Word.Interfaces.SettingCollectionData; } /** - * Specifies the options for adding to a {@link Word.TabStopCollection} object. + * Contains a collection of {@link Word.Style} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - interface TabStopAddOptions { + class StyleCollection 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.Style[]; /** - * If provided, specifies the alignment of the tab stop. The default value is `left`. + * Get the style object by its name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * @param name Required. The style name. */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + getByName(name: string): Word.Style; /** - * If provided, specifies the leader character for the tab stop. The default value is `spaces`. + * If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * @param name Required. The style name. */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** - * Contains the collection of the document's Table objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableCollection 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.Table[]; + getByNameOrNullObject(name: string): Word.Style; /** - * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the number of the styles in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - getFirst(): Word.Table; + getCount(): OfficeExtension.ClientResult; /** - * Gets the first table 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}. + * Gets a style object by its index in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * @param index A number that identifies the index location of a style object. */ - getFirstOrNullObject(): Word.Table; + getItem(index: number): Word.Style; /** * 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.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; + load(options?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection; /** * 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.TableCollection; + load(propertyNames?: string | string[]): Word.StyleCollection; /** * 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.TableCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.StyleCollection; /** * 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.TableCollection; + track(): Word.StyleCollection; /** * 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.TableCollection; + 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.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. + * 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.TableCollectionData; + toJSON(): Word.Interfaces.StyleCollectionData; } /** - * Represents a table column in a Word document. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - class TableColumn extends OfficeExtension.ClientObject { + class Style 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; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - readonly borders: Word.BorderUniversalCollection; + readonly borders: Word.BorderCollection; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly shading: Word.ShadingUniversal; + readonly font: Word.Font; /** - * Returns the position of this column in a collection. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly columnIndex: number; + readonly frame: Word.Frame; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isFirst: boolean; + linkStyle: Word.Style; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - readonly isLast: boolean; + readonly listTemplate: Word.ListTemplate; /** - * Returns the nesting level of the column. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly nestingLevel: number; + readonly paragraphFormat: Word.ParagraphFormat; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - preferredWidth: number; + readonly shading: Word.Shading; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + readonly tableStyle: Word.TableStyle; /** - * Specifies the width of the column, in points. + * Specifies whether the style is automatically redefined based on the selection. * * @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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableColumn): void; + automaticallyUpdate: boolean; /** - * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - autoFit(): void; + baseStyle: string; /** - * Deletes the column. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - delete(): void; + readonly builtIn: boolean; /** - * Selects the table column. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + readonly description: string; /** - * Sets the width of the column in a table. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + hasProofing: boolean; /** - * Sets the width of the column in a table. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + readonly inUse: boolean; /** - * Sorts the table column. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sort(): void; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies an East Asian language for the style. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(propertyNames?: string | string[]): Word.TableColumn; + readonly linked: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the list level for the style. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableColumn; + readonly listLevelNumber: number; /** - * 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. + * Specifies whether the style cannot be changed or edited. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TableColumn; + locked: boolean; /** - * 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. + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] */ - untrack(): Word.TableColumn; + readonly nameLocal: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - toJSON(): Word.Interfaces.TableColumnData; - } - /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TableColumnCollection 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.TableColumn[]; + nextParagraphStyle: string; /** - * Returns a `TableColumn` object that represents a column added to a table. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param beforeColumn Optional. The column before which the new column is added. - * @returns A new `TableColumn` object. */ - add(beforeColumn?: Word.TableColumn): Word.TableColumn; + noSpaceBetweenParagraphsOfSameStyle: boolean; /** - * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * Specifies the priority. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - autoFit(): void; + priority: number; /** - * Deletes the specified columns. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - delete(): void; + quickStyle: boolean; /** - * Adjusts the width of the specified columns so that they are equal. + * Gets the style type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - distributeWidth(): void; + readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Selects the specified table columns. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - select(): void; + unhideWhenUsed: boolean; /** - * Sets the width of columns in a table. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + */ + visibility: boolean; + /** + * 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.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Style): void; + /** + * Deletes the style. * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * @remarks + * [Api set: WordApi 1.5] */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + delete(): void; /** - * Sets the width of columns in a table. + * Links this style to a list template so that the style's formatting can be applied to lists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param columnWidth The width to set. - * @param rulerStyle The ruler style to apply. + * @param listTemplate A `ListTemplate` to link to the style. */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + linkToListTemplate(listTemplate: Word.ListTemplate): 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.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; + load(options?: Word.Interfaces.StyleLoadOptions): Word.Style; /** * 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.TableColumnCollection; + load(propertyNames?: string | string[]): Word.Style; /** * 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.TableColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Style; /** * 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.TableColumnCollection; + track(): Word.Style; /** * 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.TableColumnCollection; + 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.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableColumnCollectionData; + toJSON(): Word.Interfaces.StyleData; } /** - * Represents a table of authorities in a Word document. + * Represents the shading object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - class TableOfAuthorities extends OfficeExtension.ClientObject { + class Shading 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 portion of a document that is this table of authorities. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - readonly range: Word.Range; + backgroundPatternColor: string; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bookmark: string; + foregroundPatternColor: string; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - category: number; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - entrySeparator: string; + set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shading): void; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - isCategoryHeaderIncluded: boolean; + load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - isEntryFormattingKept: boolean; + load(propertyNames?: string | string[]): Word.Shading; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isPassimUsed: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Shading; /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * 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.Shading; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.ShadingData; + } + /** + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ShadingUniversal 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; + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator: string; + backgroundPatternColor: string; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator: string; + backgroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName: string; + foregroundPatternColor: string; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator: string; + foregroundPatternColorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; /** * 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.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ShadingUniversalUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfAuthorities): void; - /** - * Deletes this table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - delete(): void; + set(properties: Word.ShadingUniversal): 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.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; + load(options?: Word.Interfaces.ShadingUniversalLoadOptions): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + load(propertyNames?: string | string[]): Word.ShadingUniversal; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -116570,1478 +116762,1535 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableOfAuthorities; + }): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + track(): Word.ShadingUniversal; /** * 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.TableOfAuthorities; + untrack(): Word.ShadingUniversal; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShadingUniversal` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadingUniversalData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableOfAuthoritiesData; + toJSON(): Word.Interfaces.ShadingUniversalData; } /** - * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. + * Represents a table in a Word document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - class TableOfAuthoritiesCollection extends OfficeExtension.ClientObject { + class Table 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.TableOfAuthorities[]; /** - * Adds a table of authorities to the document at the specified range. + * Returns the `TableColumnCollection` object that represents the columns in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. - * @param options Optional. The options to configure the table of authorities. */ - add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; + readonly columns: Word.TableColumnCollection; /** - * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. + * Gets the collection of endnotes in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param shortCitation The citation text to mark. - * @param options Optional. The options for marking the citation. + * [Api set: WordApi 1.5] */ - markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; + readonly endnotes: Word.NoteItemCollection; /** - * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param range The range where the citation will be inserted. - * @param shortCitation The short citation text. - * @param options Optional. The options for marking the citation. + * [Api set: WordApi 1.4] */ - markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; + readonly fields: Word.FieldCollection; /** - * Finds and selects the next instance of the specified citation text. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param shortCitation The citation text to search for. + * [Api set: WordApi 1.3] */ - selectNextCitation(shortCitation: string): void; + readonly font: Word.Font; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the collection of footnotes in the table. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.5] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; + readonly footnotes: Word.NoteItemCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the parent body of the table. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; + readonly parentBody: Word.Body; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; + readonly parentContentControl: Word.ContentControl; /** - * 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. + * 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] */ - track(): Word.TableOfAuthoritiesCollection; + readonly parentContentControlOrNullObject: Word.ContentControl; /** - * 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. + * 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] */ - untrack(): Word.TableOfAuthoritiesCollection; + readonly parentTable: 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.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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] */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; - } - /** - * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TableOfAuthoritiesAddOptions { + readonly parentTableCell: Word.TableCell; /** - * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. - When specified, the entries are collected only from the portion of the document marked by the bookmark. - Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookmark?: string; + readonly parentTableCellOrNullObject: Word.TableCell; /** - * If provided, specifies the category of entries to include in a table of authorities. - Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. - The default value is `1`. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - category?: number; + readonly parentTableOrNullObject: Word.Table; /** - * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. - Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, no separator is used. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - entrySeparator?: string; + readonly rows: Word.TableRowCollection; /** - * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). - Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `true`. + * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includeCategoryHeader?: boolean; + readonly shading: Word.ShadingUniversal; /** - * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. - Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `true`. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - keepEntryFormatting?: boolean; + readonly tables: Word.TableCollection; /** - * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. - Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, a comma and a space (", ") are used. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageNumberSeparator?: string; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. - Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, an en dash ("–") is used. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator?: string; + description: string; /** - * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. - Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sequenceName?: string; + headerRowCount: number; /** - * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. - Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - If omitted, a hyphen ("-") is used. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sequenceSeparator?: string; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". - Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. - The default value is `false`. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - usePassim?: boolean; - } - /** - * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TableOfAuthoritiesMarkCitationOptions { + readonly isUniform: boolean; /** - * If provided, specifies the category number to be associated with the entry. - Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. - The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. - To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - category?: number; + readonly nestingLevel: number; /** - * If provided, specifies the long citation for the entry as it will appear in a table of authorities. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - longCitation?: string; + readonly rowCount: number; /** - * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - longCitationAutoText?: string; - } - /** - * Represents a category used in a table of authorities. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TableOfAuthoritiesCategory 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; + shadingColor: string; /** - * Specifies the name of this table of authorities category. - Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. + * Specifies the style name for the table. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly name: string; + style: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the table has banded columns. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; + styleBandedColumns: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the table has banded rows. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; + styleBandedRows: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * - * @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.TableOfAuthoritiesCategory; - /** - * 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. + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableOfAuthoritiesCategory; + styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * 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. + * Specifies whether the table has a first column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - untrack(): Word.TableOfAuthoritiesCategory; + styleFirstColumn: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; - } - /** - * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TableOfAuthoritiesCategoryCollection 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.TableOfAuthoritiesCategory[]; + styleLastColumn: boolean; /** - * Returns the number of items in the collection. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - getCount(): OfficeExtension.ClientResult; + styleTotalRow: boolean; /** - * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The index of the item to retrieve. */ - getItemAt(index: number): Word.TableOfAuthoritiesCategory; + title: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the text values in the table, as a 2D JavaScript array. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; + values: string[][]; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of the table in points. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; + width: number; /** - * 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. + * 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. */ - track(): Word.TableOfAuthoritiesCategoryCollection; + set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Table): void; /** - * 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. + * Adds columns to the start or end of the table, using the first or last existing column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. It must be 'Start' or 'End', corresponding to the appropriate side of the table. + * @param columnCount Required. Number of columns to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - untrack(): Word.TableOfAuthoritiesCategoryCollection; + addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Adds rows to the start or end of the table, using the first or last existing row as a template. The string values, if specified, are set in the newly inserted rows. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. It must be 'Start' or 'End'. + * @param rowCount Required. Number of rows to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; - } - /** - * Represents a table of contents in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TableOfContents 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; + addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. + * Applies the specified style but maintains any formatting that a user directly applies. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param styleName The name of the style to apply. */ - readonly additionalHeadingStyles: Word.HeadingStyleCollection; + applyStyleDirectFormatting(styleName: string): void; /** - * Gets the portion of a document that is this table of contents. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ - readonly range: Word.Range; + autoFitBehavior(behavior: Word.AutoFitBehavior): void; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param behavior How Word resizes the specified table with the AutoFit feature is used. */ - areBuiltInHeadingStylesUsed: boolean; + autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Autofits the table columns to the width of the window. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areFieldsUsed: boolean; + autoFitWindow(): void; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Applies a predefined look to a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for applying the table format. */ - areHyperlinksUsedOnWeb: boolean; + autoFormat(options?: Word.TableAutoFormatOptions): void; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Clears the contents of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - arePageNumbersHiddenOnWeb: boolean; + clear(): void; /** - * Specifies whether page numbers are included in the table of contents. + * Converts a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options An object that specifies the options for converting the table to text. + * @returns A `Range` object that represents the converted text. */ - arePageNumbersIncluded: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Deletes the entire table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - arePageNumbersRightAligned: boolean; + delete(): void; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Deletes specific columns. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param columnIndex Required. The first column to delete. + * @param columnCount Optional. The number of columns to delete. Default 1. */ - lowerHeadingLevel: number; + deleteColumns(columnIndex: number, columnCount?: number): void; /** - * Specifies the character between entries and their page numbers in the table of contents. + * Deletes specific rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rowIndex Required. The first row to delete. + * @param rowCount Optional. The number of rows to delete. Default 1. */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + deleteRows(rowIndex: number, rowCount?: number): void; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Distributes the column widths evenly. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tableId: string; + distributeColumns(): void; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - upperHeadingLevel: number; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * 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. + * Gets the border style for the specified border. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfContents): void; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Deletes this table of contents. + * Gets the table cell at a specified row and column. Throws an `ItemNotFound` error if the specified table cell doesn't exist. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param rowIndex Required. The index of the row. + * @param cellIndex Required. The index of the cell in the row. */ - delete(): void; + getCell(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Updates the entire table of contents. + * Gets the table cell at a specified row and column. If the specified table cell doesn't exist, 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 + * [Api set: WordApi 1.3] + * + * @param rowIndex Required. The index of the row. + * @param cellIndex Required. The index of the cell in the row. + */ + getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell; /** - * Updates only the page numbers for items in this table of contents. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - updatePageNumbers(): void; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets cell padding in points. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next table. Throws an `ItemNotFound` error if this table is the last one. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TableOfContents; + getNext(): Word.Table; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next table. If this table is the last one, 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}. * - * @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. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableOfContents; + getNextOrNullObject(): Word.Table; /** - * 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. + * Gets the paragraph after the table. Throws an `ItemNotFound` error if there isn't a paragraph after the table. + * + * @remarks + * [Api set: WordApi 1.3] */ - track(): Word.TableOfContents; + getParagraphAfter(): Word.Paragraph; /** - * 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. + * Gets the paragraph after the table. If there isn't a paragraph after the 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] */ - untrack(): Word.TableOfContents; + getParagraphAfterOrNullObject(): 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.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. + * Gets the paragraph before the table. Throws an `ItemNotFound` error if there isn't a paragraph before the table. + * + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TableOfContentsData; - } - /** - * Represents a collection of {@link Word.TableOfContents} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TableOfContentsCollection 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.TableOfContents[]; + getParagraphBefore(): Word.Paragraph; /** - * Adds a table of contents to the document at the specified range. + * Gets the paragraph before the table. If there isn't a paragraph before the 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] + */ + getParagraphBeforeOrNullObject(): Word.Paragraph; + /** + * Gets the range that contains this table, or the range at the start or end of the table. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rangeLocation Optional. The range location must be 'Whole', 'Start', 'End', or 'After'. + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range; + /** + * Inserts a content control on the table. + * + * @remarks + * [Api set: WordApi 1.3] + */ + insertContentControl(): Word.ContentControl; + /** + * Inserts a paragraph at the specified location. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param paragraphText Required. The paragraph text to be inserted. + * @param insertLocation Required. The value must be 'Before' or 'After'. + */ + insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph; + /** + * Inserts a table with the specified number of rows and columns. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param rowCount Required. The number of rows in the table. + * @param columnCount Required. The number of columns in the table. + * @param insertLocation Required. The value must be 'Before' or 'After'. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + */ + insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table; + /** + * Merges the cells bounded inclusively by a first and last cell. + * + * @remarks + * [Api set: WordApi 1.4] + * + * @param topRow Required. The row of the first cell + * @param firstCell Required. The index of the first cell in its row + * @param bottomRow Required. The row of the last cell + * @param lastCell Required. The index of the last cell in its row + */ + mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + reapplyAutoFormat(): void; + /** + * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. * - * @param range The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. - * @param options Optional. The options for configuring the table of contents. + * @remarks + * [Api set: WordApi 1.3] + * + * @param searchText Required. The search text. + * @param searchOptions Optional. Options for the search. */ - add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: Word.SelectionMode): void; + /** + * Selects the table, or the position at the start or end of the table, and navigates the Word UI to it. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + */ + select(selectionMode?: "Select" | "Start" | "End"): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + /** + * Sets cell padding in points. + * + * @remarks + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. + */ + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Sorts the specified table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param range The range where the entry will be inserted. - * @param options Optional. The options for marking the table of contents entry. + * @param options An object that specifies the options for sorting the table. */ - markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; + sort(options?: Word.TableSortOptions): 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.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; + load(options?: Word.Interfaces.TableLoadOptions): Word.Table; /** * 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.TableOfContentsCollection; + load(propertyNames?: string | string[]): Word.Table; /** * 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.TableOfContentsCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Table; /** * 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.TableOfContentsCollection; + track(): Word.Table; /** * 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.TableOfContentsCollection; + 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.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableOfContentsCollectionData; + toJSON(): Word.Interfaces.TableData; } /** - * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. + * Represents the TableStyle object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - interface TableOfContentsAddOptions { + class TableStyle 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; /** - * If provided, specifies the string names of additional styles to use for the table of contents. - Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. + * Returns a `BorderUniversalCollection` that represents all the borders for the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - addedStyles?: string; + readonly borders: Word.BorderUniversalCollection; /** - * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. - The default value is `true`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hidePageNumbersOnWeb?: boolean; + readonly shading: Word.Shading; /** - * If provided, specifies whether to include page numbers in a table of contents. - The default value is `true`. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - includePageNumbers?: boolean; + alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. - Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - The default value is `9`. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lowerHeadingLevel?: number; + allowBreakAcrossPage: boolean; /** - * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. - The default value is `true`. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - rightAlignPageNumbers?: boolean; + bottomCellMargin: number; /** - * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. - Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. - If this argument is omitted, TC fields aren't used. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - tableId?: string; + cellSpacing: number; /** - * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. - Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - The default value is `1`. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; + columnStripe: number; /** - * If provided, specifies whether to use built-in heading styles to create a table of contents. - The default value is `true`. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useBuiltInHeadingStyles?: boolean; + isBreakAcrossPagesAllowed: boolean; /** - * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. - Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. - The default value is `false`. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - useFields?: boolean; + leftCellMargin: number; /** - * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. - The default value is `true`. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useHyperlinksOnWeb?: boolean; + leftIndent: number; /** - * If provided, specifies whether to use outline levels to create a table of contents. - The default value is `false`. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - useOutlineLevels?: boolean; - } - /** - * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TableOfContentsMarkEntryOptions { + rightCellMargin: number; /** - * If provided, specifies the text that appears in a table of contents or table of figures. - To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). - When the `entryAutoText` property is set, this property is ignored. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + rowStripe: number; /** - * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. - When this property is used, the `entry` property is ignored. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin: 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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableStyle): void; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param conditionCode The area of the table to which to apply the formatting. */ - level?: number; + condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; /** - * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param conditionCode The area of the table to which to apply the formatting. */ - tableId?: string; + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; + /** + * 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.TableStyleLoadOptions): Word.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.TableStyle; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableStyleData; } /** - * Represents a table of figures in a Word document. + * Represents a tab stop in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class TableOfFigures extends OfficeExtension.ClientObject { + class TabStop 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 additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. + * Gets the next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly additionalHeadingStyles: Word.HeadingStyleCollection; + readonly next: Word.TabStop; /** - * Gets the portion of a document that is this table of figures. + * Gets the previous tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + readonly previous: Word.TabStop; /** - * Specifies whether built-in heading styles are used for the table of figures. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed: boolean; + readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed: boolean; + readonly customTab: boolean; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb: boolean; + readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb: boolean; + readonly position: number; /** - * Specifies whether page numbers are included in the table of figures. + * Removes this custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded: boolean; + clear(): void; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - arePageNumbersRightAligned: boolean; + load(options?: Word.Interfaces.TabStopLoadOptions): Word.TabStop; /** - * Specifies the label that identifies the items to be included in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - captionLabel: string; + load(propertyNames?: string | string[]): Word.TabStop; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isLabelIncluded: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TabStop; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lowerHeadingLevel: number; + track(): Word.TabStop; /** - * Specifies the character between entries and their page numbers in the table of figures. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + untrack(): Word.TabStop; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TabStop` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TabStopData; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TabStopCollection 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.TabStop[]; + /** + * Returns a `TabStop` object that represents a custom tab stop added to the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param position The position of the tab stop. + * @param options Optional. The options to further configure the new tab stop. */ - tableId: string; + add(position: number, options?: Word.TabStopAddOptions): Word.TabStop; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Returns the next `TabStop` object to the right of the specified position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param Position The position to check. */ - upperHeadingLevel: 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.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableOfFigures): void; + after(Position: number): Word.TabStop; /** - * Deletes this table of figures. + * Returns the next `TabStop` object to the left of the specified position. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param Position The position to check. */ - delete(): void; + before(Position: number): Word.TabStop; /** - * Updates the entire table of figures. + * Clears all the custom tab stops from the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + clearAll(): void; /** - * Updates only the page numbers for items in this table of figures. + * Gets a `TabStop` object by its index in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a `TabStop` object. */ - updatePageNumbers(): void; + getItem(index: number): Word.TabStop; /** * 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.TableOfFiguresLoadOptions): Word.TableOfFigures; + load(options?: Word.Interfaces.TabStopCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TabStopCollection; /** * 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.TableOfFigures; + load(propertyNames?: string | string[]): Word.TabStopCollection; /** * 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.TableOfFigures; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TabStopCollection; /** * 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.TableOfFigures; + track(): Word.TabStopCollection; /** * 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.TableOfFigures; + untrack(): Word.TabStopCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TabStopCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TabStopCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableOfFiguresData; + toJSON(): Word.Interfaces.TabStopCollectionData; } /** - * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. + * Specifies the options for adding to a {@link Word.TabStopCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class TableOfFiguresCollection 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.TableOfFigures[]; + interface TabStopAddOptions { /** - * Adds a table of figures to the document at the specified range. + * If provided, specifies the alignment of the tab stop. The default value is `left`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. - * @param options Optional. The options for configuring the table of figures. */ - add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. + * If provided, specifies the leader character for the tab stop. The default value is `spaces`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** + * Contains the collection of the document's Table objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class TableCollection 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.Table[]; + /** + * Gets the first table in this collection. Throws an `ItemNotFound` error if this collection is empty. * - * @param range The range where the TC field will be inserted. - * @param options Optional. The options for marking the entry. + * @remarks + * [Api set: WordApi 1.3] */ - markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; + getFirst(): Word.Table; + /** + * Gets the first table 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 1.3] + */ + getFirstOrNullObject(): Word.Table; /** * 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.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; + load(options?: Word.Interfaces.TableCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCollection; /** * 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.TableOfFiguresCollection; + load(propertyNames?: string | string[]): Word.TableCollection; /** * 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.TableOfFiguresCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCollection; /** * 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.TableOfFiguresCollection; + track(): Word.TableCollection; /** * 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.TableOfFiguresCollection; + 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.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.TableOfFiguresCollectionData; + toJSON(): Word.Interfaces.TableCollectionData; } /** - * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableOfFiguresAddOptions { + class TableColumn 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; /** - * If provided, specifies the string names of additional styles to use for the table of figures. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - addedStyles?: string; + readonly borders: Word.BorderUniversalCollection; /** - * If provided, specifies the label that identifies the items to include in a table of figures. - * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is "Figure". + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - captionLabel?: string; + readonly shading: Word.ShadingUniversal; /** - * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. - * The default value is `true`. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hidePageNumbersOnWeb?: boolean; + readonly columnIndex: number; /** - * If provided, specifies whether to include the caption label and caption number in a table of figures. - * The default value is `true`. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includeLabel?: boolean; + readonly isFirst: boolean; /** - * If provided, specifies whether page numbers are included in a table of figures. - * The default value is `true`. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includePageNumbers?: boolean; + readonly isLast: boolean; /** - * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. - * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `9`. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + readonly nestingLevel: number; /** - * If provided, specifies whether to align page numbers with the right margin in a table of figures. - * The default value is `true`. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + preferredWidth: number; /** - * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. - * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. - * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `1`. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; + width: number; /** - * If provided, specifies whether to use built-in heading styles to create a table of figures. - * The default value is `false`. + * 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.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableColumn): void; + /** + * Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useBuiltInHeadingStyles?: boolean; + autoFit(): void; /** - * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. - * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. - * The default value is `false`. + * Deletes the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useFields?: boolean; + delete(): void; /** - * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. - * The default value is `true`. + * Selects the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useHyperlinksOnWeb?: boolean; - } - /** - * Represents a row in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableRow 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; + select(): void; /** - * Gets cells. + * Sets the width of the column in a table. * * @remarks - * [Api set: WordApi 1.3] - */ - readonly cells: Word.TableCellCollection; - /** - * Gets the collection of endnotes in the table row. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.5] + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - readonly endnotes: Word.NoteItemCollection; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Gets the collection of field objects in the table row. + * Sets the width of the column in a table. * * @remarks - * [Api set: WordApi 1.4] - */ - readonly fields: Word.FieldCollection; - /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.3] + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - readonly font: Word.Font; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Gets the collection of footnotes in the table row. + * Sorts the table column. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly footnotes: Word.NoteItemCollection; + sort(): void; /** - * Gets parent table. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - readonly parentTable: Word.Table; + load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn; /** - * Returns the `Range` object that represents the table row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly range: Word.Range; + load(propertyNames?: string | string[]): Word.TableColumn; /** - * Returns the `ShadingUniversal` object that represents the shading of the table row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - readonly shading: Word.ShadingUniversal; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableColumn; /** - * Gets the number of cells in the row. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - readonly cellCount: number; + track(): Word.TableColumn; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. - * - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + untrack(): Word.TableColumn; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. - * - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object. */ - readonly isHeader: boolean; + toJSON(): Word.Interfaces.TableColumnData; + } + /** + * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableColumnCollection 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.TableColumn[]; /** - * Specifies the preferred height of the row in points. + * Returns a `TableColumn` object that represents a column added to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param beforeColumn Optional. The column before which the new column is added. + * @returns A new `TableColumn` object. */ - preferredHeight: number; + add(beforeColumn?: Word.TableColumn): Word.TableColumn; /** - * Gets the index of the row in its parent table. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + autoFit(): void; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Deletes the specified columns. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + delete(): void; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Adjusts the width of the specified columns so that they are equal. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values: string[][]; + distributeWidth(): void; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Selects the specified table columns. * * @remarks - * [Api set: WordApi 1.3] - */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - /** - * 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableRow): void; + select(): void; /** - * Clears the contents of the row. + * Sets the width of columns in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - clear(): void; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * Converts the table row to text. + * Sets the width of columns in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options Optional. An object that specifies the options for converting the table row to text. + * @param columnWidth The width to set. + * @param rulerStyle The ruler style to apply. */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Deletes the entire row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - delete(): void; + load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection; /** - * Gets the border style of the cells in the row. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param borderLocation Required. The border location. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + load(propertyNames?: string | string[]): Word.TableColumnCollection; /** - * Gets the border style of the cells in the row. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param borderLocation Required. The border location. + * @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. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * 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. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + track(): Word.TableColumnCollection; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * 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. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + untrack(): Word.TableColumnCollection; /** - * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. - * - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - getNext(): Word.TableRow; + toJSON(): Word.Interfaces.TableColumnCollectionData; + } + /** + * Represents a table of authorities in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfAuthorities 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 next row. If this row is the last one, 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}. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TableRow; + readonly range: Word.Range; /** - * Inserts a content control on the row. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertContentControl(): Word.ContentControl; + bookmark: string; /** - * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add - * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + category: number; /** - * Merges the row into one cell. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - merge(): Word.TableCell; + entrySeparator: string; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param searchText Required. The search text. - * @param searchOptions Optional. Options for the search. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + isCategoryHeaderIncluded: boolean; /** - * Selects the row and navigates the Word UI to it. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: Word.SelectionMode): void; + isEntryFormattingKept: boolean; /** - * Selects the row and navigates the Word UI to it. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.3] - * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: "Select" | "Start" | "End"): void; + isPassimUsed: boolean; /** - * Sets cell padding in points. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + pageNumberSeparator: string; /** - * Sets cell padding in points. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + pageRangeSeparator: string; /** - * Sets the height of the row. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight The height of the row, in points. - * @param heightRule The rule for determining the height of the table row. */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + sequenceName: string; /** - * Sets the height of the row. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight The height of the row, in points. - * @param heightRule The rule for determining the height of the table row. */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + sequenceSeparator: string; /** - * Sets the left indent for the table row. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. - * @param rulerStyle The ruler style to apply. */ - setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Sets the left indent for the table row. + * 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.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfAuthorities): void; + /** + * Deletes this table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. - * @param rulerStyle The ruler style to apply. */ - setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + delete(): 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.TableRowLoadOptions): Word.TableRow; + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; /** * 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.TableRow; + load(propertyNames?: string | string[]): Word.TableOfAuthorities; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -118050,1053 +118299,927 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableRow; + }): Word.TableOfAuthorities; /** * 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.TableRow; + track(): Word.TableOfAuthorities; /** * 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.TableRow; + untrack(): Word.TableOfAuthorities; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableRowData; + toJSON(): Word.Interfaces.TableOfAuthoritiesData; } /** - * Contains the collection of the document's TableRow objects. + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableRowCollection extends OfficeExtension.ClientObject { + class TableOfAuthoritiesCollection 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.TableRow[]; - /** - * Converts rows in a table to text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options Optional. An object that specifies the options for converting the table rows to text. - * @returns A `Range` object that represents the converted text. - */ - convertToText(options?: Word.TableConvertToTextOptions): Word.Range; - /** - * Deletes the table rows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - delete(): void; - /** - * Adjusts the height of the rows so that they're equal. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - distributeHeight(): void; - /** - * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getFirst(): Word.TableRow; - /** - * Gets the first row 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 1.3] - */ - getFirstOrNullObject(): Word.TableRow; - /** - * Selects the table rows. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - select(): void; + readonly items: Word.TableOfAuthorities[]; /** - * Sets the height of the cells in a table. + * Adds a table of authorities to the document at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param rowHeight The height of the row, in points. - * @param heightRule The rule for determining the height of the specified rows. + * @param range The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. + * @param options Optional. The options to configure the table of authorities. */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; /** - * Sets the height of the cells in a table. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param rowHeight The height of the row, in points. - * @param heightRule The rule for determining the height of the specified rows. + * @param shortCitation The citation text to mark. + * @param options Optional. The options for marking the citation. */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; /** - * Sets the left indent for the table row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. - * @param rulerStyle The ruler style to apply. + * @param range The range where the citation will be inserted. + * @param shortCitation The short citation text. + * @param options Optional. The options for marking the citation. */ - setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; + markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; /** - * Sets the left indent for the table row. + * Finds and selects the next instance of the specified citation text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. - * @param rulerStyle The ruler style to apply. + * @param shortCitation The citation text to search for. */ - setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + selectNextCitation(shortCitation: string): 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.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; /** * 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.TableRowCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; /** * 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.TableRowCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; /** * 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.TableRowCollection; + track(): Word.TableOfAuthoritiesCollection; /** * 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.TableRowCollection; + untrack(): Word.TableOfAuthoritiesCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableRowCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; } /** - * Represents a table cell in a Word document. + * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableCell 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; + interface TableOfAuthoritiesAddOptions { /** - * Gets the body object of the cell. + * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. + When specified, the entries are collected only from the portion of the document marked by the bookmark. + Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + bookmark?: string; /** - * Returns the `TableColumn` object that represents the table column that contains this cell. + * If provided, specifies the category of entries to include in a table of authorities. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly column: Word.TableColumn; + category?: number; /** - * Gets the parent row of the cell. + * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, no separator is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentRow: Word.TableRow; + entrySeparator?: string; /** - * Gets the parent table of the cell. + * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). + Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTable: Word.Table; + includeCategoryHeader?: boolean; /** - * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + keepEntryFormatting?: boolean; /** - * Gets the index of the cell in its row. + * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. + Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a comma and a space (", ") are used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellIndex: number; + pageNumberSeparator?: string; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. + Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, an en dash ("–") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth: number; + pageRangeSeparator?: string; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. + Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + sequenceName?: string; /** - * Gets the index of the cell's row in the table. + * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. + Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a hyphen ("-") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + sequenceSeparator?: string; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `false`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + usePassim?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfAuthoritiesMarkCitationOptions { /** - * Specifies the text of the cell. + * If provided, specifies the category number to be associated with the entry. + Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. + The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. + To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value: string; + category?: number; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * If provided, specifies the long citation for the entry as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + longCitation?: string; /** - * Gets the width of the cell in points. + * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly 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.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableCell): void; - /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - autoSum(): void; - /** - * Deletes the table cell and optionally controls how the remaining cells are shifted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. - */ - delete(shiftCells: any): void; - /** - * Deletes the column containing this cell. This is applicable to uniform tables. - * - * @remarks - * [Api set: WordApi 1.3] - */ - deleteColumn(): void; - /** - * Deletes the row containing this cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - deleteRow(): void; + longCitationAutoText?: string; + } + /** + * Represents a category used in a table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfAuthoritiesCategory 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; /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. An object that specifies the options for the formula. - */ - formula(options?: Word.TableCellFormulaOptions): void; - /** - * Gets the border style for the specified border. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation Required. The border location. - */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; - /** - * Gets the border style for the specified border. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation Required. The border location. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + readonly name: string; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param options Provides options for which properties of the object to load. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; /** - * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getNext(): Word.TableCell; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthoritiesCategory; /** - * Gets the next cell. If this cell is the last one, 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] + * 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. */ - getNextOrNullObject(): Word.TableCell; + track(): Word.TableOfAuthoritiesCategory; /** - * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param columnCount Required. Number of columns to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * 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. */ - insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + untrack(): Word.TableOfAuthoritiesCategory; /** - * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; + } + /** + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfAuthoritiesCategoryCollection 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.TableOfAuthoritiesCategory[]; /** - * Merges this table cell with the specified table cell. + * Returns the number of items in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param mergeTo The cell to be merged with. */ - merge(mergeTo: Word.TableCell): void; + getCount(): OfficeExtension.ClientResult; /** - * Selects the table cell. + * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - select(): void; - /** - * Sets cell padding in points. * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. - */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; - /** - * Sets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. - */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; - /** - * Splits the cell into the specified number of rows and columns. - * - * @remarks - * [Api set: WordApi 1.4] - * - * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount Required. The number of columns to split into. + * @param index The index of the item to retrieve. */ - split(rowCount: number, columnCount: number): void; + getItemAt(index: number): Word.TableOfAuthoritiesCategory; /** * 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.TableCellLoadOptions): Word.TableCell; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; /** * 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.TableCell; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; /** * 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.TableCell; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; /** * 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.TableCell; + track(): Word.TableOfAuthoritiesCategoryCollection; /** * 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.TableCell; + untrack(): Word.TableOfAuthoritiesCategoryCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableCellData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; } /** - * Contains the collection of the document's TableCell objects. + * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableCellCollection extends OfficeExtension.ClientObject { + class TableOfContents 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.TableCell[]; /** - * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. + * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit(): void; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Deletes the table cells and optionally controls how the remaining cells are shifted. + * Gets the portion of a document that is this table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - delete(shiftCells?: Word.DeleteCells): void; + readonly range: Word.Range; /** - * Deletes the table cells and optionally controls how the remaining cells are shifted. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; + areBuiltInHeadingStylesUsed: boolean; /** - * Adjusts the height of the specified cells so that they are equal. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distributeHeight(): void; + areFieldsUsed: boolean; /** - * Adjusts the width of the specified cells so that they are equal. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distributeWidth(): void; + areHyperlinksUsedOnWeb: boolean; /** - * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableCell; + arePageNumbersHiddenOnWeb: boolean; /** - * Gets the first table cell 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}. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.TableCell; + arePageNumbersIncluded: boolean; /** - * Merges the specified cells into a single cell. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - merge(): void; + arePageNumbersRightAligned: boolean; /** - * Sets the height of the cells in a table. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight The height of the row to set, in points. - * @param heightRule The rule for determining the height of the specified rows. */ - setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + lowerHeadingLevel: number; /** - * Sets the height of the cells in a table. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param rowHeight The height of the row to set, in points. - * @param heightRule The rule for determining the height of the specified rows. */ - setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Sets the width of the cells in a table. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param columnWidth The width of the row to set, in points. - * @param rulerStyle The ruler style to apply. */ - setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + tableId: string; /** - * Sets the width of the cells in a table. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + upperHeadingLevel: 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.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfContents): void; + /** + * Deletes this table of contents. * - * @param columnWidth The width of the row to set, in points. - * @param rulerStyle The ruler style to apply. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + delete(): void; /** - * Splits this range of table cells. + * Updates the entire table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + /** + * Updates only the page numbers for items in this table of contents. * - * @param options TableCellCollectionSplitOptions. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - split(options?: Word.TableCellCollectionSplitOptions): void; + updatePageNumbers(): 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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; /** * 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.TableCellCollection; + load(propertyNames?: string | string[]): Word.TableOfContents; /** * 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.TableCellCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; /** * 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.TableCellCollection; + track(): Word.TableOfContents; /** * 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.TableCellCollection; + untrack(): Word.TableOfContents; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableCellCollectionData; + toJSON(): Word.Interfaces.TableOfContentsData; } /** - * Specifies the border style. + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableBorder extends OfficeExtension.ClientObject { + class TableOfContentsCollection 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.TableOfContents[]; /** - * Specifies the table border color. + * Adds a table of contents to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] - */ - color: string; - /** - * Specifies the type of the table border. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.3] + * @param range The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of contents. */ - type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. * * @remarks - * [Api set: WordApi 1.3] - */ - 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where the entry will be inserted. + * @param options Optional. The options for marking the table of contents entry. */ - set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableBorder): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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.TableBorderLoadOptions): Word.TableBorder; + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; /** * 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.TableBorder; + load(propertyNames?: string | string[]): Word.TableOfContentsCollection; /** * 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.TableBorder; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfContentsCollection; /** * 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.TableBorder; + track(): Word.TableOfContentsCollection; /** * 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.TableBorder; + untrack(): Word.TableOfContentsCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableBorderData; + toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** - * Represents a document template. + * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Template 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; + interface TableOfContentsAddOptions { /** - * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * If provided, specifies the string names of additional styles to use for the table of contents. + Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + addedStyles?: string; /** - * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + hidePageNumbersOnWeb?: boolean; /** - * Returns a `ListTemplateCollection` object that represents all the list templates in the template. + * If provided, specifies whether to include page numbers in a table of contents. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplates: Word.ListTemplateCollection; + includePageNumbers?: boolean; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + lowerHeadingLevel?: number; /** - * Specifies the line break control level for the document. + * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + rightAlignPageNumbers?: boolean; /** - * Returns the name of the template, including the drive or Web path. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. + If this argument is omitted, TC fields aren't used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fullName: string; + tableId?: string; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing: boolean; + upperHeadingLevel?: number; /** - * Specifies the character spacing adjustment for the template. + * If provided, specifies whether to use built-in heading styles to create a table of contents. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + useBuiltInHeadingStyles?: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. + Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm: boolean; + useFields?: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + useHyperlinksOnWeb?: boolean; /** - * Specifies an East Asian language for the language in the template. + * If provided, specifies whether to use outline levels to create a table of contents. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + useOutlineLevels?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfContentsMarkEntryOptions { /** - * Returns only the name of the document template (excluding any path or other location information). + * If provided, specifies the text that appears in a table of contents or table of figures. + To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). + When the `entryAutoText` property is set, this property is ignored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + entry?: string; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. + When this property is used, the `entry` property is ignored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter: string; + entryAutoText?: string; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore: string; + level?: number; /** - * Returns the path to the document template. + * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly path: string; + tableId?: string; + } + /** + * Represents a table of figures in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfFigures 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; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved: boolean; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Returns the template type. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; + readonly range: Word.Range; /** - * 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. + * Specifies whether built-in heading styles are used for the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Template): void; + areBuiltInHeadingStylesUsed: boolean; /** - * Saves the template. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - save(): void; + areFieldsUsed: boolean; /** - * 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.TemplateLoadOptions): Word.Template; - /** - * 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.Template; - /** - * 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.Template; - /** - * 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.Template; - /** - * 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.Template; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TemplateData; - } - /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TemplateCollection 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.Template[]; - /** - * Returns the number of items in the collection. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getCount(): OfficeExtension.ClientResult; + areHyperlinksUsedOnWeb: boolean; /** - * Gets a `Template` object by its index in the collection. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The index of the template to retrieve. */ - getItemAt(index: number): Word.Template; + arePageNumbersHiddenOnWeb: boolean; /** - * Imports the building blocks for all templates into Microsoft Word. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - importBuildingBlocks(): 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.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + arePageNumbersIncluded: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TemplateCollection; + arePageNumbersRightAligned: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the label that identifies the items to be included in the table of figures. * - * @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.TemplateCollection; - /** - * 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.TemplateCollection; - /** - * 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.TemplateCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TemplateCollectionData; - } - /** - * Represents a tracked change in a Word document. - * - * @remarks - * [Api set: WordApi 1.6] - */ - class TrackedChange 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; + captionLabel: string; /** - * Gets the author of the tracked change. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly author: string; + isLabelIncluded: boolean; /** - * Gets the date of the tracked change. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly date: Date; + lowerHeadingLevel: number; /** - * Gets the text of the tracked change. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly text: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the type of the tracked change. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + tableId: string; /** - * Accepts the tracked change. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accept(): void; + upperHeadingLevel: number; /** - * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. - * - * @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. */ - getNext(): Word.TrackedChange; + set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfFigures): void; /** - * Gets the next tracked change. If this tracked change is the last one, 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}. + * Deletes this table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TrackedChange; + delete(): void; /** - * Gets the range of the tracked change. + * Updates the entire table of figures. * * @remarks - * [Api set: WordApi 1.6] - */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta /** - * Rejects the tracked change. + * Updates only the page numbers for items in this table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reject(): void; + updatePageNumbers(): 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.TrackedChangeLoadOptions): Word.TrackedChange; + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures; /** * 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.TrackedChange; + load(propertyNames?: string | string[]): Word.TableOfFigures; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -119105,948 +119228,992 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TrackedChange; + }): Word.TableOfFigures; /** * 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.TrackedChange; + track(): Word.TableOfFigures; /** * 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.TrackedChange; + untrack(): Word.TableOfFigures; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TrackedChangeData; + toJSON(): Word.Interfaces.TableOfFiguresData; } /** - * Contains a collection of {@link Word.TrackedChange} objects. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TrackedChangeCollection extends OfficeExtension.ClientObject { + class TableOfFiguresCollection 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.TrackedChange[]; + readonly items: Word.TableOfFigures[]; /** - * Accepts all the tracked changes in the collection. + * Adds a table of figures to the document at the specified range. * * @remarks - * [Api set: WordApi 1.6] - */ - acceptAll(): void; - /** - * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.6] + * @param range The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of figures. */ - getFirst(): Word.TrackedChange; + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; /** - * Gets the first TrackedChange 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}. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. * * @remarks - * [Api set: WordApi 1.6] - */ - getFirstOrNullObject(): Word.TrackedChange; - /** - * Rejects all the tracked changes in the collection. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApi 1.6] + * @param range The range where the TC field will be inserted. + * @param options Optional. The options for marking the entry. */ - rejectAll(): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; /** * 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.TrackedChangeCollection; + load(propertyNames?: string | string[]): Word.TableOfFiguresCollection; /** * 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.TrackedChangeCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfFiguresCollection; /** * 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.TrackedChangeCollection; + track(): Word.TableOfFiguresCollection; /** * 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.TrackedChangeCollection; + untrack(): Word.TableOfFiguresCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TrackedChangeCollectionData; + toJSON(): Word.Interfaces.TableOfFiguresCollectionData; } /** - * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. + * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class View 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; + interface TableOfFiguresAddOptions { /** - * Gets the instance of a `RevisionsFilter` object. + * If provided, specifies the string names of additional styles to use for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly revisionsFilter: Word.RevisionsFilter; + addedStyles?: string; /** - * Specifies whether all nonprinting characters are displayed. + * If provided, specifies the label that identifies the items to include in a table of figures. + * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is "Figure". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed: boolean; + captionLabel?: string; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed: boolean; + hidePageNumbersOnWeb?: boolean; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * If provided, specifies whether to include the caption label and caption number in a table of figures. + * The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areBookmarksIndicated: boolean; + includeLabel?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * If provided, specifies whether page numbers are included in a table of figures. + * The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed: boolean; + includePageNumbers?: boolean; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is `9`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed: boolean; + lowerHeadingLevel?: number; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * If provided, specifies whether to align page numbers with the right margin in a table of figures. + * The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areCropMarksDisplayed: boolean; + rightAlignPageNumbers?: boolean; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. + * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areDrawingsDisplayed: boolean; + tableId?: string; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + * The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded: boolean; + upperHeadingLevel?: number; /** - * Specifies whether field codes are displayed. + * If provided, specifies whether to use built-in heading styles to create a table of figures. + * The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed: boolean; + useBuiltInHeadingStyles?: boolean; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. + * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. + * The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed: boolean; + useFields?: boolean; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. + * The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed: boolean; + useHyperlinksOnWeb?: boolean; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class TableRow 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; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Gets cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areInsertionsAndDeletionsDisplayed: boolean; + readonly cells: Word.TableCellCollection; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Gets the collection of endnotes in the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly areLinesWrappedToWindow: boolean; + readonly endnotes: Word.NoteItemCollection; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Gets the collection of field objects in the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - readonly areObjectAnchorsDisplayed: boolean; + readonly fields: Word.FieldCollection; /** - * Gets whether Microsoft Word displays optional line breaks. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areOptionalBreaksDisplayed: boolean; + readonly font: Word.Font; /** - * Gets whether optional hyphens are displayed. + * Gets the collection of footnotes in the table row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - readonly areOptionalHyphensDisplayed: boolean; + readonly footnotes: Word.NoteItemCollection; /** - * Gets whether other authors' presence should be visible in the document. + * Gets parent table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areOtherAuthorsVisible: boolean; + readonly parentTable: Word.Table; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Returns the `Range` object that represents the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly arePageBoundariesDisplayed: boolean; + readonly range: Word.Range; /** - * Gets whether paragraph marks are displayed. + * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areParagraphsMarksDisplayed: boolean; + readonly shading: Word.ShadingUniversal; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly arePicturePlaceholdersDisplayed: boolean; + readonly cellCount: number; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areRevisionsAndCommentsDisplayed: boolean; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets whether space characters are displayed. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areSpacesIndicated: boolean; + readonly isHeader: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areTableGridlinesDisplayed: boolean; + preferredHeight: number; /** - * Gets whether tab characters are displayed. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areTabsDisplayed: boolean; + readonly rowIndex: number; /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areTextBoundariesDisplayed: boolean; + shadingColor: string; /** - * Specifies the column width in Reading mode. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + values: string[][]; /** - * Gets on-screen shading for fields. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - isDraft: boolean; + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; /** - * Specifies whether only the first line of body text is shown in outline view. + * Clears the contents of the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFirstLineOnlyDisplayed: boolean; + clear(): void; /** - * Specifies whether character formatting is visible in outline view. + * Converts the table row to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for converting the table row to text. */ - isFormatDisplayed: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether the window is in full-screen view. + * Deletes the entire row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFullScreen: boolean; + delete(): void; /** - * Gets whether text formatted as hidden text is displayed. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - readonly isHiddenTextDisplayed: boolean; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - readonly isHighlightingDisplayed: boolean; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies whether the document is in conflict mode view. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - isInConflictMode: boolean; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies whether Microsoft Word is in Panning mode. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - isInPanning: boolean; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Specifies whether the document is being viewed in reading layout view. + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isInReadingLayout: boolean; + getNext(): Word.TableRow; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Gets the next row. If this row is the last one, 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 + * [Api set: WordApi 1.3] */ - isMailMergeDataView: boolean; + getNextOrNullObject(): Word.TableRow; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Inserts a content control on the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isMainTextLayerVisible: boolean; + insertContentControl(): Word.ContentControl; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. + * @param rowCount Required. Number of rows to add + * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ - isPointerShownAsMagnifier: boolean; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Merges the row into one cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isReadingLayoutActualView: boolean; + merge(): Word.TableCell; /** - * Specifies whether XML tags are visible in the document. + * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param searchText Required. The search text. + * @param searchOptions Optional. Options for the search. */ - isXmlMarkupVisible: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies the display mode for tracked changes. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + select(selectionMode?: Word.SelectionMode): void; /** - * Specifies the page color in Reading mode. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Specifies the page movement type. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Specifies the width of the revision balloons. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - revisionsBalloonWidth: number; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Specifies the document element displayed in print layout view. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Specifies the active window pane. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + load(options?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; /** - * Specifies the view type. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + load(propertyNames?: string | string[]): Word.TableRow; /** - * 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. + * 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. */ - set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.View): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableRow; /** - * Collapses all the headings in the document. + * 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.TableRow; + /** + * 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.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. + */ + toJSON(): Word.Interfaces.TableRowData; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class TableRowCollection 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.TableRow[]; + /** + * Converts rows in a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for converting the table rows to text. + * @returns A `Range` object that represents the converted text. */ - collapseAllHeadings(): void; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Collapses the text under the selection or the specified range by one heading level. + * Deletes the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range A `Range` object that specifies the range to collapse. */ - collapseOutline(range: Word.Range): void; + delete(): void; /** - * Expands all the headings in the document. + * Adjusts the height of the rows so that they're equal. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expandAllHeadings(): void; + distributeHeight(): void; /** - * Expands the text under the selection by one heading level. + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.TableRow; + /** + * Gets the first row 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 1.3] + */ + getFirstOrNullObject(): Word.TableRow; + /** + * Selects the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range A `Range` object that specifies the range to expand. */ - expandOutline(range: Word.Range): void; + select(): void; /** - * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - nextHeaderFooter(): void; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - previousHeaderFooter(): void; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Switches between showing all text (headings and body text) and showing only headings. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - showAllHeadings(): void; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Shows all headings up to the specified heading level and hides subordinate headings and body text. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param level The heading level to show. + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - showHeading(level: number): void; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): 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.ViewLoadOptions): Word.View; + load(options?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; /** * 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.View; + load(propertyNames?: string | string[]): Word.TableRowCollection; /** * 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.View; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableRowCollection; /** * 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.View; + track(): Word.TableRowCollection; /** * 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.View; + 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.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ViewData; + toJSON(): Word.Interfaces.TableRowCollectionData; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a table cell in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - class Shape extends OfficeExtension.ClientObject { + class TableCell 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 text boxes and geometric shapes. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ readonly body: Word.Body; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly canvas: Word.Canvas; + readonly column: Word.TableColumn; /** - * Returns the fill formatting of the shape. + * Gets the parent row of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly fill: Word.ShapeFill; + readonly parentRow: Word.TableRow; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Gets the parent table of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly parentCanvas: Word.Shape; + readonly parentTable: Word.Table; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentGroup: Word.Shape; + readonly shading: Word.ShadingUniversal; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapeGroup: Word.ShapeGroup; + readonly cellIndex: number; /** - * Gets the text frame object of the shape. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textFrame: Word.TextFrame; + columnWidth: number; /** - * Returns the text wrap formatting of the shape. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textWrap: Word.ShapeTextWrap; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether a given shape can overlap other shapes. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - allowOverlap: boolean; + readonly rowIndex: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - altTextDescription: string; + shadingColor: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + value: string; /** - * The height, in points, of the shape. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height: number; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heightRelative: number; + readonly width: number; /** - * Gets an integer that represents the shape identifier. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. */ - readonly id: number; + set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isChild: boolean; + autoSum(): void; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Deletes the table cell and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - left: number; - /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - leftRelative: number; + delete(shiftCells: any): void; /** - * Specifies if the aspect ratio of this shape is locked. + * Deletes the column containing this cell. This is applicable to uniform tables. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + deleteColumn(): void; /** - * The name of the shape. + * Deletes the row containing this cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - name: string; + deleteRow(): void; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; - /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Optional. An object that specifies the options for the formula. */ - relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + formula(options?: Word.TableCellFormulaOptions): void; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - rotation: number; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - top: number; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topRelative: number; + getNext(): Word.TableCell; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the next cell. If this cell is the last one, 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + getNextOrNullObject(): Word.TableCell; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. It must be 'Before' or 'After'. + * @param columnCount Required. Number of columns to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - visible: boolean; + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; /** - * The width, in points, of the shape. + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. It must be 'Before' or 'After'. + * @param rowCount Required. Number of rows to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - width: number; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Merges this table cell with the specified table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - widthRelative: 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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param mergeTo The cell to be merged with. */ - 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; + merge(mergeTo: Word.TableCell): void; /** - * Deletes the shape and its content. + * Selects the table cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + select(): void; /** - * Moves the shape horizontally by the number of points. + * Sets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] * - * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - moveHorizontally(distance: number): void; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Moves the shape vertically by the number of points. + * Sets cell padding in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] * - * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - moveVertically(distance: number): void; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Splits the cell into the specified number of rows and columns. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount Required. The number of columns to split into. */ - scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + split(rowCount: number, columnCount: number): void; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * @param options Provides options for which properties of the object to load. */ - scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; - /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. - */ - scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; - /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. - */ - scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; - /** - * Selects the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @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; + load(options?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; /** * 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; + load(propertyNames?: string | string[]): Word.TableCell; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -120055,151 +120222,234 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shape; + }): Word.TableCell; /** * 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; + track(): Word.TableCell; /** * 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; + 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.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. + * 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.ShapeData; + toJSON(): Word.Interfaces.TableCellData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Contains the collection of the document's TableCell objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - class ShapeGroup extends OfficeExtension.ClientObject { + class TableCellCollection 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.TableCell[]; /** - * Gets the Shape object associated with the group. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly shape: Word.Shape; + autoFit(): void; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly shapes: Word.ShapeCollection; + delete(shiftCells?: Word.DeleteCells): void; /** - * Gets an integer that represents the shape group identifier. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly id: number; + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; /** - * 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. + * Adjusts the height of the specified cells so that they are equal. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeGroup): void; + distributeHeight(): void; /** - * Ungroups any grouped shapes in the specified shape group. + * Adjusts the width of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ungroup(): Word.ShapeCollection; + distributeWidth(): void; + /** + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * + * @remarks + * [Api set: WordApi 1.3] + */ + getFirst(): Word.TableCell; + /** + * Gets the first table cell 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 1.3] + */ + getFirstOrNullObject(): Word.TableCell; + /** + * Merges the specified cells into a single cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + merge(): void; + /** + * Sets the height of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. + */ + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; + /** + * Sets the height of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. + */ + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; + /** + * Sets the width of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. + */ + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; + /** + * Sets the width of the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. + */ + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; + /** + * Splits this range of table cells. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options TableCellCollectionSplitOptions. + */ + split(options?: Word.TableCellCollectionSplitOptions): 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.ShapeGroupLoadOptions): Word.ShapeGroup; + load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; /** * 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.ShapeGroup; + load(propertyNames?: string | string[]): Word.TableCellCollection; /** * 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.ShapeGroup; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; /** * 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.ShapeGroup; + track(): Word.TableCellCollection; /** * 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.ShapeGroup; + 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.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ShapeGroupData; + toJSON(): Word.Interfaces.TableCellCollectionData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Specifies the border style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - class Canvas extends OfficeExtension.ClientObject { + class TableBorder 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 Shape object associated with the canvas. + * Specifies the table border color. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shape: Word.Shape; + color: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapes: Word.ShapeCollection; + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Gets an integer that represents the canvas identifier. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly id: number; + 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.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Canvas): void; + set(properties: Word.TableBorder): 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.CanvasLoadOptions): Word.Canvas; + load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; /** * 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.Canvas; + load(propertyNames?: string | string[]): Word.TableBorder; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -120208,212 +120458,195 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Canvas; + }): Word.TableBorder; /** * 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.Canvas; + track(): Word.TableBorder; /** * 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.Canvas; + 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.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + * 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.CanvasData; + toJSON(): Word.Interfaces.TableBorderData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Represents a document template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class ShapeCollection extends OfficeExtension.ClientObject { + class Template 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 the shapes that have the specified geometric types. Only applied to geometric shapes. + * Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types Required. An array of geometric shape subtypes. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; /** - * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id Required. A shape identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getById(id: number): Word.Shape; + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; /** - * 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}. + * Returns a `ListTemplateCollection` object that represents all the list templates in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id Required. A shape identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByIdOrNullObject(id: number): Word.Shape; + readonly listTemplates: Word.ListTemplateCollection; /** - * Gets the shapes by the identifiers. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param ids Required. An array of shape identifiers. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByIds(ids: number[]): Word.ShapeCollection; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the shapes that have the specified names. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param names Required. An array of shape names. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByNames(names: string[]): Word.ShapeCollection; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the shapes that have the specified types. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types Required. An array of shape types. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + readonly fullName: string; /** - * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.Shape; + hasNoProofing: boolean; /** - * 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}. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.Shape; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - group(): Word.Shape; + kerningByAlgorithm: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `LanguageId` value that represents the language in the template. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies an East Asian language for the language in the template. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeCollection; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns only the name of the document template (excluding any path or other location information). * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeCollection; + readonly name: string; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is 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. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeCollectionData; - } - /** - * Represents the fill formatting of a shape object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class ShapeFill 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; + noLineBreakAfter: string; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor: string; + noLineBreakBefore: string; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns the path to the document template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor: string; + readonly path: string; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency: number; + saved: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Returns the template type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; /** * 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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeFill): void; - /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - clear(): void; + set(properties: Word.Template): void; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Saves the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setSolidColor(color: string): void; + save(): 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.ShapeFillLoadOptions): Word.ShapeFill; + load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; /** * 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.ShapeFill; + load(propertyNames?: string | string[]): Word.Template; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -120422,275 +120655,177 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.ShapeFill; + }): Word.Template; /** * 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.ShapeFill; + track(): Word.Template; /** * 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.ShapeFill; + untrack(): Word.Template; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeFillData; + toJSON(): Word.Interfaces.TemplateData; } /** - * Represents the text frame of a shape object. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TextFrame extends OfficeExtension.ClientObject { + class TemplateCollection 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.Template[]; /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + getCount(): OfficeExtension.ClientResult; /** - * Represents the bottom margin, in points, of the text frame. + * Gets a `Template` object by its index in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - bottomMargin: number; - /** - * Specifies if the text frame contains text. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param index The index of the template to retrieve. */ - readonly hasText: boolean; + getItemAt(index: number): Word.Template; /** - * Represents the left margin, in points, of the text frame. + * Imports the building blocks for all templates into Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin: number; + importBuildingBlocks(): void; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - noTextRotation: boolean; + load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + load(propertyNames?: string | string[]): Word.TemplateCollection; /** - * Represents the right margin, in points, of the text frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @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. */ - rightMargin: number; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; /** - * Represents the top margin, in points, of the text frame. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. */ - topMargin: number; + track(): Word.TemplateCollection; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. - * - * @remarks - * [Api set: WordApiDesktop 1.2] + * 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. */ - verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; - /** - * Determines whether lines break automatically to fit text inside the shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - wordWrap: boolean; - /** - * 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.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextFrame): 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.TextFrameLoadOptions): Word.TextFrame; - /** - * 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.TextFrame; - /** - * 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.TextFrame; - /** - * 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.TextFrame; - /** - * 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.TextFrame; + untrack(): Word.TemplateCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TextFrameData; + toJSON(): Word.Interfaces.TemplateCollectionData; } /** - * Represents all the properties for wrapping text around a shape. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - class ShapeTextWrap extends OfficeExtension.ClientObject { + class TrackedChange 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; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - bottomDistance: number; + readonly author: string; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - leftDistance: number; + readonly date: Date; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - rightDistance: number; + readonly text: string; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Accepts the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - topDistance: number; + accept(): void; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - /** - * 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.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeTextWrap): 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. + * [Api set: WordApi 1.6] */ - load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; + getNext(): Word.TrackedChange; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the next tracked change. If this tracked change is the last one, 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}. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.6] */ - load(propertyNames?: string | string[]): Word.ShapeTextWrap; + getNextOrNullObject(): Word.TrackedChange; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the range of the tracked change. * - * @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.ShapeTextWrap; - /** - * 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.ShapeTextWrap; - /** - * 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.ShapeTextWrap; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.6] */ - toJSON(): Word.Interfaces.ShapeTextWrapData; - } - /** - * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Reviewer 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; + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; /** - * Specifies if the `Reviewer` object is visible. + * Rejects the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isVisible: boolean; - /** - * 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. + * [Api set: WordApi 1.6] */ - set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Reviewer): void; + reject(): 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.ReviewerLoadOptions): Word.Reviewer; + load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; /** * 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.Reviewer; + load(propertyNames?: string | string[]): Word.TrackedChange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -120699,694 +120834,608 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Reviewer; + }): Word.TrackedChange; /** * 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.Reviewer; + track(): Word.TrackedChange; /** * 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.Reviewer; + 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.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + * 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.ReviewerData; + toJSON(): Word.Interfaces.TrackedChangeData; } /** - * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - class ReviewerCollection extends OfficeExtension.ClientObject { + class TrackedChangeCollection 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.Reviewer[]; + readonly items: Word.TrackedChange[]; /** - * Returns a `Reviewer` object that represents the specified item in the collection. + * Accepts all the tracked changes in the collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] + */ + acceptAll(): void; + /** + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. * - * @param index The index of the item to retrieve. + * @remarks + * [Api set: WordApi 1.6] */ - getItem(index: number): Word.Reviewer; + getFirst(): Word.TrackedChange; + /** + * Gets the first TrackedChange 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 1.6] + */ + getFirstOrNullObject(): Word.TrackedChange; + /** + * Rejects all the tracked changes in the collection. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rejectAll(): 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.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; + load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + load(propertyNames?: string | string[]): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + track(): Word.TrackedChangeCollection; /** * 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.ReviewerCollection; + 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.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * 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.ReviewerCollectionData; + toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class RevisionsFilter extends OfficeExtension.ClientObject { + class View 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 `ReviewerCollection` object that represents the collection of reviewers of one or more documents. + * Gets the instance of a `RevisionsFilter` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly reviewers: Word.ReviewerCollection; + readonly revisionsFilter: Word.RevisionsFilter; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; + areAllNonprintingCharactersDisplayed: boolean; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view: Word.RevisionsView | "Final" | "Original"; - /** - * 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.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RevisionsFilter): void; + areBackgroundsDisplayed: boolean; /** - * Shows or hides all revisions in the document that contain comments and tracked changes. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggleShowAllReviewers(): void; + readonly areBookmarksIndicated: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays the comments in the document. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; + areCommentsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RevisionsFilter; + areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * - * @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.RevisionsFilter; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RevisionsFilter; + readonly areCropMarksDisplayed: boolean; /** - * 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. + * Gets whether objects created with the drawing tools are displayed in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RevisionsFilter; + readonly areDrawingsDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RevisionsFilterData; - } - /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class RepeatingSectionItem 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; + areEditableRangesShaded: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + areFieldCodesDisplayed: boolean; /** - * 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. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionItem): void; + areFormatChangesDisplayed: boolean; /** - * Deletes this `RepeatingSectionItem` object. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + areInkAnnotationsDisplayed: boolean; /** - * Adds a repeating section item after this item and returns the new item. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertItemAfter(): Word.RepeatingSectionItem; + areInsertionsAndDeletionsDisplayed: boolean; /** - * Adds a repeating section item before this item and returns the new item. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertItemBefore(): Word.RepeatingSectionItem; + readonly areLinesWrappedToWindow: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; + readonly areObjectAnchorsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether Microsoft Word displays optional line breaks. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItem; + readonly areOptionalBreaksDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether optional hyphens are displayed. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItem; + readonly areOptionalHyphensDisplayed: boolean; /** - * 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. + * Gets whether other authors' presence should be visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RepeatingSectionItem; + areOtherAuthorsVisible: boolean; /** - * 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. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RepeatingSectionItem; + readonly arePageBoundariesDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + * Gets whether paragraph marks are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RepeatingSectionItemData; - } - /** - * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class RepeatingSectionItemCollection 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; + readonly areParagraphsMarksDisplayed: boolean; /** - * Returns an individual repeating section item. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The index of the item to retrieve. - * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - getItemAt(index: number): Word.RepeatingSectionItem; + readonly arePicturePlaceholdersDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; + areRevisionsAndCommentsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether space characters are displayed. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItemCollection; + readonly areSpacesIndicated: boolean; /** - * 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. + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RepeatingSectionItemCollection; + areTableGridlinesDisplayed: boolean; /** - * 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. + * Gets whether tab characters are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RepeatingSectionItemCollection; + readonly areTabsDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): { - [key: string]: string; - }; - } - /** - * Represents a single tracked change in a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Revision 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; + readonly areTextBoundariesDisplayed: boolean; /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Specifies the column width in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly movedRange: Word.Range; + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Gets on-screen shading for fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Gets the name of the user who made the tracked change. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly author: string; + isDraft: boolean; /** - * Gets the date and time when the tracked change was made. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly date: Date; + isFirstLineOnlyDisplayed: boolean; /** - * Gets the description of tracked formatting changes in the revision. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly formatDescription: string; + isFormatDisplayed: boolean; /** - * Gets a number that represents the position of this item in a collection. + * Specifies whether the window is in full-screen view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly index: number; + isFullScreen: boolean; /** - * Gets the revision type. + * Gets whether text formatted as hidden text is displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + readonly isHiddenTextDisplayed: boolean; /** - * 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. + * Gets whether highlight formatting is displayed and printed with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Revision): void; + readonly isHighlightingDisplayed: boolean; /** - * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. + * Specifies whether the document is in conflict mode view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accept(): void; + isInConflictMode: boolean; /** - * Rejects the tracked change. The revision marks are removed, leaving the original text intact. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reject(): void; + isInPanning: boolean; /** - * 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.RevisionLoadOptions): Word.Revision; - /** - * 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.Revision; - /** - * 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.Revision; - /** - * 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.Revision; - /** - * 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.Revision; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.RevisionData; - } - /** - * A collection of Revision objects that represent the changes marked with revision marks in a range or document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class RevisionCollection 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.Revision[]; - /** - * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - acceptAll(): void; + isInReadingLayout: boolean; /** - * Returns a `Revision` object that represents the specified item in the collection. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The index of the item to retrieve. */ - getItem(index: number): Word.Revision; + isMailMergeDataView: boolean; /** - * Rejects all the tracked changes in the document or range. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rejectAll(): 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.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; - /** - * 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.RevisionCollection; - /** - * 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.RevisionCollection; - /** - * 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.RevisionCollection; - /** - * 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.RevisionCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.RevisionCollectionData; - } - /** - * Represents the `DatePickerContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DatePickerContentControl 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; + isMainTextLayerVisible: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly placeholderText: Word.BuildingBlock; + isPointerShownAsMagnifier: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + isReadingLayoutActualView: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xmlMapping: Word.XmlMapping; + isXmlMarkupVisible: boolean; /** - * Specifies the appearance of the content control. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color: string; + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the format in which dates are displayed. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat: string; + readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + revisionsBalloonWidth: number; /** - * Gets the identification for the content control. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly id: string; + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary: boolean; + seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl: boolean; + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * 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.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.View): void; + /** + * Collapses all the headings in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents: boolean; + collapseAllHeadings(): void; /** - * Gets whether the placeholder text for the content control is being displayed. + * Collapses the text under the selection or the specified range by one heading level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range A `Range` object that specifies the range to collapse. */ - readonly showingPlaceholderText: boolean; + collapseOutline(range: Word.Range): void; /** - * Specifies a tag to identify the content control. + * Expands all the headings in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag: string; + expandAllHeadings(): void; /** - * Specifies the title for the content control. + * Expands the text under the selection by one heading level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range A `Range` object that specifies the range to expand. */ - title: string; - /** - * 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.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DatePickerContentControl): void; + expandOutline(range: Word.Range): void; /** - * Copies the content control from the active document to the Clipboard. + * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + nextHeaderFooter(): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + previousHeaderFooter(): void; /** - * Deletes this content control and the contents of the content control. + * Switches between showing all text (headings and body text) and showing only headings. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param deleteContents Optional. If true, deletes the contents as well. */ - delete(deleteContents?: boolean): void; + showAllHeadings(): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Shows all headings up to the specified heading level and hides subordinate headings and body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param options Optional. The options for configuring the content control's placeholder text. + * @param level The heading level to show. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + showHeading(level: number): 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.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; + load(options?: Word.Interfaces.ViewLoadOptions): Word.View; /** * 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.DatePickerContentControl; + load(propertyNames?: string | string[]): Word.View; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -121395,392 +121444,338 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DatePickerContentControl; + }): Word.View; /** * 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.DatePickerContentControl; + track(): Word.View; /** * 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.DatePickerContentControl; + untrack(): Word.View; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DatePickerContentControlData; + toJSON(): Word.Interfaces.ViewData; } /** - * Represents the `PictureContentControl` object. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class PictureContentControl extends OfficeExtension.ClientObject { + 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + readonly body: Word.Body; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly canvas: Word.Canvas; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly fill: Word.ShapeFill; /** - * Specifies the appearance of the content control. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + readonly parentCanvas: Word.Shape; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + readonly parentGroup: Word.Shape; /** - * Returns the identification for the content control. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + readonly shapeGroup: Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + readonly textFrame: Word.TextFrame; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + readonly textWrap: Word.ShapeTextWrap; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + allowOverlap: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + altTextDescription: string; /** - * Returns whether the placeholder text for the content control is being displayed. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies a tag to identify the content control. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + height: number; /** - * Specifies the title for the content control. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - title: string; - /** - * 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. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PictureContentControl): void; + heightRelative: number; /** - * Copies the content control from the active document to the Clipboard. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + readonly id: number; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + readonly isChild: boolean; /** - * Deletes the content control and optionally its contents. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Decides whether to delete the contents of the content control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents?: boolean): void; + left: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.PictureContentControlLoadOptions): Word.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * 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.PictureContentControl; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.PictureContentControlData; - } - /** - * Represents the `GroupContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class GroupContentControl 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; + leftRelative: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + lockAspectRatio: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * The name of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + name: string; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the appearance of the content control. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Returns the identification for the content control. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + rotation: number; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + top: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + topRelative: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + visible: boolean; /** - * Specifies a tag to identify the content control. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + width: number; /** - * Specifies the title for the content control. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + widthRelative: 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.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + 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.GroupContentControl): void; + set(properties: Word.Shape): void; /** - * Copies the content control from the active document to the Clipboard. + * Deletes the shape and its content. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + delete(): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Moves the shape horizontally by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ - cut(): void; + moveHorizontally(distance: number): void; /** - * Deletes the content control and optionally its contents. + * Moves the shape vertically by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ - delete(deleteContents: boolean): void; + moveVertically(distance: number): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param options Optional. The options for configuring the content control's placeholder text. + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - ungroup(): void; + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + /** + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + */ + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + /** + * Selects the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @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.GroupContentControlLoadOptions): Word.GroupContentControl; + 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.GroupContentControl; + 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. * @@ -121789,240 +121784,151 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.GroupContentControl; + }): 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.GroupContentControl; + 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.GroupContentControl; + 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.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.GroupContentControlData; - } - /** - * The options that define what placeholder to be used in the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ContentControlPlaceholderOptions { - /** - * If provided, specifies the `BuildingBlock` object to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - buildingBlock?: Word.BuildingBlock; - /** - * If provided, specifies the `Range` object to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Range; - /** - * If provided, specifies the text to use as placeholder. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - text?: string; + toJSON(): Word.Interfaces.ShapeData; } /** - * Represents the `BuildingBlockGalleryContentControl` object. + * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class BuildingBlockGalleryContentControl extends OfficeExtension.ClientObject { + class ShapeGroup 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly placeholderText: Word.BuildingBlock; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly shape: Word.Shape; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly shapes: Word.ShapeCollection; /** - * Specifies the appearance of the content control. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + readonly id: number; /** - * Specifies the category for the building block content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - buildingBlockCategory: string; + set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeGroup): void; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Ungroups any grouped shapes in the specified shape group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + ungroup(): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - color: string; + load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; /** - * Gets the identification for the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly id: string; + load(propertyNames?: string | string[]): Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - isTemporary: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeGroup; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + track(): Word.ShapeGroup; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lockContentControl: boolean; + untrack(): Word.ShapeGroup; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. */ - lockContents: boolean; + toJSON(): Word.Interfaces.ShapeGroupData; + } + /** + * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Canvas 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 if the placeholder text for the content control is being displayed. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + readonly shape: Word.Shape; /** - * Specifies a tag to identify the content control. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + readonly shapes: Word.ShapeCollection; /** - * Specifies the title for the content control. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly id: 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.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.BuildingBlockGalleryContentControl): void; - /** - * Copies the content control from the active document to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; - /** - * Deletes the content control and optionally its contents. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Whether to delete the contents inside the control. - */ - delete(deleteContents?: boolean): void; - /** - * Sets the placeholder text that displays in the content control until a user enters their own text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + set(properties: Word.Canvas): 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.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; + load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + load(propertyNames?: string | string[]): Word.Canvas; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -122031,215 +121937,212 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.BuildingBlockGalleryContentControl; + }): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + track(): Word.Canvas; /** * 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.BuildingBlockGalleryContentControl; + untrack(): Word.Canvas; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + toJSON(): Word.Interfaces.CanvasData; } /** - * Represents the `RepeatingSectionContentControl` object. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + 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[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types Required. An array of geometric shape subtypes. */ - readonly placeholderText: Word.BuildingBlock; + getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * 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 + * [Api set: WordApiDesktop 1.2] + * + * @param id Required. A shape identifier. */ - readonly range: Word.Range; + getById(id: number): Word.Shape; /** - * Returns the collection of repeating section items in this repeating section content control. + * 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 + * [Api set: WordApiDesktop 1.2] + * + * @param id Required. A shape identifier. */ - readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; + getByIdOrNullObject(id: number): Word.Shape; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the shapes by the identifiers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param ids Required. An array of shape identifiers. */ - readonly xmlapping: Word.XmlMapping; + getByIds(ids: number[]): Word.ShapeCollection; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Gets the shapes that have the specified names. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param names Required. An array of shape names. */ - allowInsertDeleteSection: boolean; + getByNames(names: string[]): Word.ShapeCollection; /** - * Specifies the appearance of the content control. + * Gets the shapes that have the specified types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types Required. An array of shape types. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + getFirst(): Word.Shape; /** - * Returns the identification for the content control. + * 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 + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + getFirstOrNullObject(): Word.Shape; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + group(): Word.Shape; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lockContentControl: boolean; + load(propertyNames?: string | string[]): Word.ShapeCollection; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContents: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * 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; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class ShapeFill 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; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - repeatingSectionItemTitle: string; + backgroundColor: string; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + foregroundColor: string; /** - * Specifies a tag to identify the content control. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + transparency: number; /** - * Specifies the title for the content control. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; /** * 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.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionContentControl): void; - /** - * Copies the content control from the active document to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; + set(properties: Word.ShapeFill): void; /** - * Deletes the content control and the contents of the content control. + * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents?: boolean): void; + clear(): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param options Optional. The options for configuring the content control's placeholder text. + * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + setSolidColor(color: string): 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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + load(propertyNames?: string | string[]): Word.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -122248,461 +122151,499 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RepeatingSectionContentControl; + }): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + track(): Word.ShapeFill; /** * 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.RepeatingSectionContentControl; + untrack(): Word.ShapeFill; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + toJSON(): Word.Interfaces.ShapeFillData; } /** - * Calendar types. + * Represents the text frame of a shape object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum CalendarType { + class TextFrame 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; /** - * Western calendar type. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - western = "Western", + autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Arabic calendar type. + * Represents the bottom margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arabic = "Arabic", + bottomMargin: number; /** - * Hebrew calendar type. + * Specifies if the text frame contains text. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hebrew = "Hebrew", + readonly hasText: boolean; /** - * Taiwan calendar type. + * Represents the left margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - taiwan = "Taiwan", + leftMargin: number; /** - * Japanese calendar type. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - japan = "Japan", + noTextRotation: boolean; /** - * Thai calendar type. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thai = "Thai", + orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Korean calendar type. + * Represents the right margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - korean = "Korean", + rightMargin: number; /** - * Saka Era calendar type. + * Represents the top margin, in points, of the text frame. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sakaEra = "SakaEra", + topMargin: number; /** - * Transliterated English calendar type. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - translitEnglish = "TranslitEnglish", + verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Transliterated French calendar type. + * Determines whether lines break automatically to fit text inside the shape. + * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - translitFrench = "TranslitFrench", + wordWrap: boolean; /** - * Umm al-Qura calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - umalqura = "Umalqura", - } - /** - * Date storage formats for {@link Word.DatePickerContentControl}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlDateStorageFormat { + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextFrame): void; /** - * Stores the date as text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - text = "Text", + load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; /** - * Stores the date as a date object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - date = "Date", + load(propertyNames?: string | string[]): Word.TextFrame; /** - * Stores the date as a date-time object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dateTime = "DateTime", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextFrame; + /** + * 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.TextFrame; + /** + * 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.TextFrame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextFrameData; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents all the properties for wrapping text around a shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class Frame extends OfficeExtension.ClientObject { + class ShapeTextWrap 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; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly borders: Word.BorderUniversalCollection; - /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + bottomDistance: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly shading: Word.ShadingUniversal; + leftDistance: number; /** - * Specifies the height (in points) of the frame. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - height: number; + rightDistance: number; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalDistanceFromText: number; + topDistance: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalPosition: number; + type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; /** - * Specifies if the frame is locked. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - lockAnchor: boolean; + set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeTextWrap): void; /** - * Specifies the relative horizontal position of the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; /** - * Specifies the relative vertical position of the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNames?: string | string[]): Word.ShapeTextWrap; /** - * Specifies if document text wraps around the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - textWrap: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeTextWrap; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - verticalDistanceFromText: number; + track(): Word.ShapeTextWrap; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - verticalPosition: number; + untrack(): Word.ShapeTextWrap; /** - * Specifies the width (in points) of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. */ - width: number; + toJSON(): Word.Interfaces.ShapeTextWrapData; + } + /** + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Reviewer 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; /** - * Specifies the rule used to determine the width of the frame. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + isVisible: boolean; /** * 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.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Frame): void; + set(properties: Word.Reviewer): void; /** - * Copies the frame to the Clipboard. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - copy(): void; + load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; /** - * Removes the frame from the document and places it on the Clipboard. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - cut(): void; + load(propertyNames?: string | string[]): Word.Reviewer; /** - * Deletes the frame. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - delete(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Reviewer; /** - * Selects the frame. + * 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.Reviewer; + /** + * 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.Reviewer; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReviewerData; + } + /** + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ReviewerCollection 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.Reviewer[]; + /** + * Returns a `Reviewer` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index The index of the item to retrieve. */ - select(): void; + getItem(index: number): Word.Reviewer; /** * 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.FrameLoadOptions): Word.Frame; + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; /** * 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.Frame; + load(propertyNames?: string | string[]): Word.ReviewerCollection; /** * 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.Frame; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; /** * 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.Frame; + track(): Word.ReviewerCollection; /** * 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.Frame; + untrack(): Word.ReviewerCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.FrameData; + toJSON(): Word.Interfaces.ReviewerCollectionData; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class FrameCollection extends OfficeExtension.ClientObject { + class RevisionsFilter 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.Frame[]; /** - * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range where the frame will be added. - * @returns A `Frame` object that represents the new frame. */ - add(range: Word.Range): Word.Frame; + readonly reviewers: Word.ReviewerCollection; /** - * Deletes the `FrameCollection` object. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Gets a `Frame` object by its index in the collection. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + view: Word.RevisionsView | "Final" | "Original"; + /** + * 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.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RevisionsFilter): void; + /** + * Shows or hides all revisions in the document that contain comments and tracked changes. * - * @param index The location of a `Frame` object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(index: number): Word.Frame; + toggleShowAllReviewers(): 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.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; + load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; /** * 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.FrameCollection; + load(propertyNames?: string | string[]): Word.RevisionsFilter; /** * 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.FrameCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RevisionsFilter; /** * 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.FrameCollection; + track(): Word.RevisionsFilter; /** * 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.FrameCollection; + untrack(): Word.RevisionsFilter; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.FrameCollectionData; + toJSON(): Word.Interfaces.RevisionsFilterData; } /** - * Represents a document library version. + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class DocumentLibraryVersion extends OfficeExtension.ClientObject { + class RepeatingSectionItem 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 any optional comments associated with this version of the shared document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: string; + readonly range: Word.Range; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * 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.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionItem): void; + /** + * Deletes this `RepeatingSectionItem` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modified: any; + delete(): void; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Adds a repeating section item after this item and returns the new item. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modifiedBy: string; + insertItemAfter(): Word.RepeatingSectionItem; + /** + * Adds a repeating section item before this item and returns the new item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertItemBefore(): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersion; + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -122711,565 +122652,470 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DocumentLibraryVersion; + }): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersion; + track(): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersion; + untrack(): Word.RepeatingSectionItem; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DocumentLibraryVersionData; + toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class DocumentLibraryVersionCollection extends OfficeExtension.ClientObject { + class RepeatingSectionItemCollection 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.DocumentLibraryVersion[]; - /** - * Gets a `DocumentLibraryVersion` object by its index in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param index The location of a `DocumentLibraryVersion` object. - */ - getItem(index: number): Word.DocumentLibraryVersion; /** - * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * Returns an individual repeating section item. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - isVersioningEnabled(): OfficeExtension.ClientResult; - /** - * 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. + * @param index The index of the item to retrieve. + * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; + getItemAt(index: number): Word.RepeatingSectionItem; /** * 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.DocumentLibraryVersionCollection; + load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; /** * 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.DocumentLibraryVersionCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItemCollection; /** * 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.DocumentLibraryVersionCollection; + track(): Word.RepeatingSectionItemCollection; /** * 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.DocumentLibraryVersionCollection; + untrack(): Word.RepeatingSectionItemCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + toJSON(): { + [key: string]: string; + }; } /** - * Represents the possible change tracking modes. + * Represents a single tracked change in a document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ChangeTrackingMode { + class Revision 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. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - off = "Off", + readonly movedRange: Word.Range; /** - * ChangeTracking is turned on for everyone. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trackAll = "TrackAll", + readonly range: Word.Range; /** - * Tracking is turned on for my changes only. + * Gets the name of the user who made the tracked change. + * * @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 author: string; /** + * Gets the date and time when the tracked change was made. + * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - original = "Original", + readonly date: Date; /** + * Gets the description of tracked formatting changes in the revision. + * * @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 { + readonly formatDescription: string; /** + * Gets a number that represents the position of this item in a collection. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly index: number; /** + * Gets the revision type. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - added = "Added", + set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Revision): void; /** + * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. + * * @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 { + accept(): void; /** - * No revision. + * Rejects the tracked change. The revision marks are removed, leaving the original text intact. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + reject(): void; /** - * Add 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. */ - added = "Added", + load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; /** - * Delete 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - deleted = "Deleted", + load(propertyNames?: string | string[]): Word.Revision; /** - * 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 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. */ - formatted = "Formatted", - } - /** - * Note item type - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; /** - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - footnote = "Footnote", + track(): Word.Revision; /** - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - endnote = "Endnote", + untrack(): Word.Revision; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RevisionData; } /** - * Provides information about the type of a raised event. + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum EventType { - /** - * ContentControlDeleted represents the event that the content control has been deleted. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlDeleted = "ContentControlDeleted", - /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlSelectionChanged = "ContentControlSelectionChanged", - /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlDataChanged = "ContentControlDataChanged", - /** - * ContentControlAdded represents the event a content control has been added to the document. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlAdded = "ContentControlAdded", - /** - * 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", + class RevisionCollection 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.Revision[]; /** - * Represents that a comment was deselected. + * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeselected = "CommentDeselected", + acceptAll(): void; /** - * Represents that a comment or its reply was changed. + * Returns a `Revision` object that represents the specified item in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index The index of the item to retrieve. */ - commentChanged = "CommentChanged", + getItem(index: number): Word.Revision; /** - * Represents that one or more new comments were added. + * Rejects all the tracked changes in the document or range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentAdded = "CommentAdded", - /** - * Represents that a content control has been entered. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlEntered = "ContentControlEntered", - /** - * Represents that a content control has been exited. - * @remarks - * [Api set: WordApi 1.5] - */ - contentControlExited = "ContentControlExited", - /** - * Represents that one or more new paragraphs were added. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphAdded = "ParagraphAdded", - /** - * Represents that one or more paragraphs were changed. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphChanged = "ParagraphChanged", - /** - * Represents that one or more paragraphs were deleted. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphDeleted = "ParagraphDeleted", - /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationClicked = "AnnotationClicked", + rejectAll(): void; /** - * Represents that an annotation was hovered over in the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationHovered = "AnnotationHovered", + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; /** - * Represents that one or more annotations were added in the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationInserted = "AnnotationInserted", + load(propertyNames?: string | string[]): Word.RevisionCollection; /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] + * 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. */ - annotationRemoved = "AnnotationRemoved", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; /** - * Represents an action in the annotation pop-up. - * @remarks - * [Api set: WordApi 1.8] + * 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. */ - annotationPopupAction = "AnnotationPopupAction", - } - /** - * An enum that specifies an event's source. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventSource { + track(): Word.RevisionCollection; /** - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - local = "Local", + untrack(): Word.RevisionCollection; /** - * @remarks - * [Api set: WordApi 1.5] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - remote = "Remote", + toJSON(): Word.Interfaces.RevisionCollectionData; } /** - * Provides information about the content control that raised contentControlAdded event. + * Represents the `DatePickerContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlAddedEventArgs { + class DatePickerContentControl 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; /** - * The event type. See Word.EventType for details. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly placeholderText: Word.BuildingBlock; /** - * Gets the content control IDs. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly range: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDataChanged event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDataChangedEventArgs { + readonly xmlMapping: Word.XmlMapping; /** - * The event type. See Word.EventType for details. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the content control IDs. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + color: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDeleted event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDeletedEventArgs { + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * The event type. See Word.EventType for details. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + dateDisplayFormat: string; /** - * Gets the content control IDs. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlEntered event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlEnteredEventArgs { + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * The event type. See Word.EventType for details. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly id: string; /** - * Gets the content control IDs. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + isTemporary: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlExited event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlExitedEventArgs { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The event type. See Word.EventType for details. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + lockContentControl: boolean; /** - * Gets the content control IDs. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + lockContents: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Represents a dropped capital letter in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DropCap 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; + readonly showingPlaceholderText: boolean; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly distanceFromText: number; + tag: string; /** - * Gets the name of the font for the dropped capital letter. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fontName: string; + title: string; /** - * Gets the height (in lines) of the dropped capital letter. + * 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.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DatePickerContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly linesToDrop: number; + copy(): void; /** - * Gets the position of the dropped capital letter. + * Removes the content control from the active document and moves the content control to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; + cut(): void; /** - * Removes the dropped capital letter formatting. + * Deletes this content control and the contents of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents Optional. If true, deletes the contents as well. */ - clear(): void; + delete(deleteContents?: boolean): void; /** - * Formats the first character in the specified paragraph as a dropped capital letter. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - enable(): void; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.DropCapLoadOptions): Word.DropCap; + load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; /** * 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.DropCap; + load(propertyNames?: string | string[]): Word.DatePickerContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -123278,14569 +123124,15059 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DropCap; + }): Word.DatePickerContentControl; /** * 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.DropCap; + track(): Word.DatePickerContentControl; /** * 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.DropCap; + untrack(): Word.DatePickerContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DropCapData; + toJSON(): Word.Interfaces.DatePickerContentControlData; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlSelectionChangedEventArgs { + class PictureContentControl 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; /** - * The event type. See Word.EventType for details. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly placeholderText: Word.BuildingBlock; /** - * Gets the content control IDs. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly range: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the paragraphs that raised the paragraphAdded event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphAddedEventArgs { + readonly xmlMapping: Word.XmlMapping; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The event type. See Word.EventType for details. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + color: string; /** - * 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. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphChanged event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphChangedEventArgs { + readonly id: string; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + isTemporary: boolean; /** - * The event type. See Word.EventType for details. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * 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. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphDeleted event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphDeletedEventArgs { + lockContentControl: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + lockContents: boolean; /** - * The event type. See Word.EventType for details. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.6] + * [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"; + readonly showingPlaceholderText: boolean; /** - * 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. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the comments that raised the comment event. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CommentEventArgs { + tag: string; /** - * Represents how the comment changed event is triggered. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; + title: string; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * 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.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PictureContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDetails: Word.CommentDetail[]; + copy(): void; /** - * The source of the event. It can be local or remote (through coauthoring). + * Removes the content control from the active document and moves the content control to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - source: Word.EventSource | "Local" | "Remote"; + cut(): void; /** - * The event type. See Word.EventType for details. + * Deletes the content control and optionally its contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents Optional. Decides whether to delete the contents of the content control. */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; - } - /** - * A structure for the ID and reply IDs of this comment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CommentDetail { + delete(deleteContents?: boolean): void; /** - * Represents the ID of this comment. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - id: string; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents the IDs of the replies to this comment. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - replyIds: string[]; + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * 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.PictureContentControl; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PictureContentControlData; } /** - * Represents how the comments in the event were changed. + * Represents the `GroupContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CommentChangeType { + class GroupContentControl 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; /** - * No comment changed event is triggered. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + readonly placeholderText: Word.BuildingBlock; /** - * A comment was edited. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edited = "edited", + readonly range: Word.Range; /** - * A comment was resolved. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resolved = "resolved", + readonly xmlMapping: Word.XmlMapping; /** - * A comment was reopened. + * Specifies the appearance of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reopened = "reopened", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * A reply was added. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyAdded = "replyAdded", + color: string; /** - * A reply was deleted. + * Returns the identification for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyDeleted = "replyDeleted", + readonly id: string; /** - * A reply was edited. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyEdited = "replyEdited", - } - /** - * Specifies supported content control types and subtypes. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum ContentControlType { + isTemporary: boolean; /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextInline = "RichTextInline", + lockContentControl: boolean; /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextParagraphs = "RichTextParagraphs", + lockContents: boolean; /** - * Contains a whole cell. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTableCell = "RichTextTableCell", + readonly showingPlaceholderText: boolean; /** - * Contains a whole row. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTableRow = "RichTextTableRow", + tag: string; /** - * Contains a whole table. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richTextTable = "RichTextTable", + title: string; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - plainTextInline = "PlainTextInline", + set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GroupContentControl): void; /** + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainTextParagraph = "PlainTextParagraph", + copy(): void; /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + cut(): void; /** + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - buildingBlockGallery = "BuildingBlockGallery", + delete(deleteContents: boolean): void; /** + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - checkBox = "CheckBox", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** + * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBox = "ComboBox", + ungroup(): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dropDownList = "DropDownList", + load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - datePicker = "DatePicker", + load(propertyNames?: string | string[]): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - repeatingSection = "RepeatingSection", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GroupContentControl; /** - * Identifies a rich text content control. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richText = "RichText", + track(): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - plainText = "PlainText", + untrack(): Word.GroupContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - group = "Group", + toJSON(): Word.Interfaces.GroupContentControlData; } /** - * ContentControl appearance. + * The options that define what placeholder to be used in the content control. * * @remarks - * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ContentControlAppearance { + interface ContentControlPlaceholderOptions { /** - * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * If provided, specifies the `BuildingBlock` object to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boundingBox = "BoundingBox", + buildingBlock?: Word.BuildingBlock; /** - * Represents a content control shown as start and end markers. + * If provided, specifies the `Range` object to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tags = "Tags", + range?: Word.Range; /** - * Represents a content control that isn't shown. + * If provided, specifies the text to use as placeholder. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", + text?: string; } /** - * Content control level types. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ContentControlLevel { + class BuildingBlockGalleryContentControl 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 an inline content control. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + readonly placeholderText: Word.BuildingBlock; /** - * Represents a paragraph-level content control. + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + readonly range: Word.Range; /** - * Represents a row-level content control. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + readonly xmlMapping: Word.XmlMapping; /** - * Represents a cell-level content control. + * Specifies the appearance of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cell = "Cell", - } - /** - * Represents the state of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlState { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Error state. + * Specifies the category for the building block content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - error = "Error", + buildingBlockCategory: string; /** - * Warning state. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warning = "Warning", - } - /** - * The supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { + buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + color: string; /** - * No underline. + * Gets the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + readonly id: string; /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", + isTemporary: boolean; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] - */ - dotLine = "DotLine", - /** - * A single underline. This is the default value. - * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - single = "Single", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Only underline individual words. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - word = "Word", + lockContentControl: boolean; /** - * A double underline. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - double = "Double", + lockContents: boolean; /** - * A single thick underline. + * Gets if the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thick = "Thick", + readonly showingPlaceholderText: boolean; /** - * A dotted underline. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + tag: string; /** + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dottedHeavy = "DottedHeavy", + title: string; /** - * A single dash underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dashLine = "DashLine", + set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BuildingBlockGalleryContentControl): void; /** + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineHeavy = "DashLineHeavy", + copy(): void; /** + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLong = "DashLineLong", + cut(): void; /** + * Deletes the content control and optionally its contents. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - dashLineLongHeavy = "DashLineLongHeavy", + delete(deleteContents?: boolean): void; /** - * An alternating dot-dash underline. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options The options for configuring the content control's placeholder text. */ - dotDashLine = "DotDashLine", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dotDashLineHeavy = "DotDashLineHeavy", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; /** - * An alternating dot-dot-dash underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - twoDotDashLine = "TwoDotDashLine", + load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; /** - * A single wavy underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - wave = "Wave", + track(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - waveHeavy = "WaveHeavy", + untrack(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - waveDouble = "WaveDouble", + toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; } /** - * Specifies the form of a break. + * Represents the `RepeatingSectionContentControl` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BreakType { + class RepeatingSectionContentControl 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; /** - * Page break at the insertion point. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - page = "Page", + readonly placeholderText: Word.BuildingBlock; /** - * Warning: next has been deprecated. Use sectionNext instead. - * @deprecated Use sectionNext instead. + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - next = "Next", + readonly range: Word.Range; /** - * Section break on next page. + * Returns the collection of repeating section items in this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionNext = "SectionNext", + readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; /** - * New section without a corresponding page break. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionContinuous = "SectionContinuous", + readonly xmlapping: Word.XmlMapping; /** - * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionEven = "SectionEven", + allowInsertDeleteSection: boolean; /** - * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionOdd = "SectionOdd", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Line break. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - line = "Line", - } - /** - * The insertion location types. - * - * @remarks - * [Api set: WordApi 1.1] - * - * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. - */ - enum InsertLocation { + color: string; /** - * Add content before the contents of the calling object. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + readonly id: string; /** - * Add content after the contents of the calling object. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", + isTemporary: boolean; /** - * Prepend content to the contents of the calling object. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Append content to the contents of the calling object. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + lockContentControl: boolean; /** - * Replace the contents of the current object. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replace = "Replace", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum Alignment { + lockContents: boolean; /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + repeatingSectionItemTitle: string; /** - * Unknown alignment. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly showingPlaceholderText: boolean; /** - * Alignment to the left. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + tag: string; /** - * Alignment to the center. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - centered = "Centered", + title: string; /** - * Alignment to the right. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - right = "Right", + set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionContentControl): void; /** - * Fully justified alignment. + * Copies the content control from the active document to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - justified = "Justified", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum HeaderFooterType { + copy(): void; /** - * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - primary = "Primary", + cut(): void; /** - * Returns the header or footer on the first page of a section. + * Deletes the content control and the contents of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - firstPage = "FirstPage", + delete(deleteContents?: boolean): void; /** - * Returns all headers or footers on even-numbered pages of a section. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - evenPages = "EvenPages", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * 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.RepeatingSectionContentControl; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.RepeatingSectionContentControlData; } /** - * Represents the types of body objects. + * Represents one of the readability statistics for the document or range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BodyType { - /** - * Unknown body type. - * @remarks - * [Api set: WordApi 1.3] - */ - unknown = "Unknown", - /** - * Main document body. - * @remarks - * [Api set: WordApi 1.3] - */ - mainDoc = "MainDoc", + class ReadabilityStatistic 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; /** - * Section body. + * Returns the name of the readability statistic. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - section = "Section", + readonly name: string; /** - * Header body. + * Returns the value of the grammar statistic. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + readonly value: number; /** - * Footer body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - footer = "Footer", + load(options?: Word.Interfaces.ReadabilityStatisticLoadOptions): Word.ReadabilityStatistic; /** - * Table cell body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableCell = "TableCell", + load(propertyNames?: string | string[]): Word.ReadabilityStatistic; /** - * Footnote body. - * @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 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. */ - footnote = "Footnote", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReadabilityStatistic; /** - * Endnote body. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - endnote = "Endnote", + track(): Word.ReadabilityStatistic; /** - * Note body e.g., endnote, footnote. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - noteItem = "NoteItem", + untrack(): Word.ReadabilityStatistic; /** - * Shape body. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatistic` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticData`) that contains shallow copies of any loaded child properties from the original object. */ - shape = "Shape", + toJSON(): Word.Interfaces.ReadabilityStatisticData; } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum SelectionMode { + class ReadabilityStatisticCollection 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.ReadabilityStatistic[]; /** - * The entire range is selected. + * Gets the readability statistic at the specified index. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The zero-based index of the readability statistic to get. */ - select = "Select", + getItemAt(index: number): Word.ReadabilityStatistic; /** - * The cursor is at the beginning of the selection (just before the start of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - start = "Start", + load(options?: Word.Interfaces.ReadabilityStatisticCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReadabilityStatisticCollection; /** - * The cursor is at the end of the selection (just after the end of the selected range). - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - end = "End", + load(propertyNames?: string | string[]): Word.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * 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.ReadabilityStatisticCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReadabilityStatisticCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReadabilityStatisticCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ReadabilityStatisticCollectionData; } /** + * Represents the settings for saving a Word document as a webpage. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ImageFormat { + class WebSettings 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; /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unsupported = "Unsupported", + allowPng: boolean; /** + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - undefined = "Undefined", + encoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bmp = "Bmp", + readonly folderSuffix: string; /** + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - jpeg = "Jpeg", + organizeInFolder: boolean; /** + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gif = "Gif", + pixelsPerInch: number; /** + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tiff = "Tiff", + relyOnCSS: boolean; /** + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - png = "Png", + relyOnVectorMarkupLanguage: boolean; /** + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - icon = "Icon", + screenSize: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** + * Specifies the target browser for documents viewed in a web browser. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - exif = "Exif", + targetBrowser: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wmf = "Wmf", + useLongFileNames: boolean; /** + * Sets the folder suffix for the specified document to the default suffix for the language support you have selected or installed. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - emf = "Emf", + useDefaultFolderSuffix(): void; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pict = "Pict", + load(options?: Word.Interfaces.WebSettingsLoadOptions): Word.WebSettings; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pdf = "Pdf", + load(propertyNames?: string | string[]): Word.WebSettings; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - svg = "Svg", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.WebSettings; + /** + * 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.WebSettings; + /** + * 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.WebSettings; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.WebSettings` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.WebSettingsData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.WebSettingsData; } /** - * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum RangeLocation { + class XmlNodeCollection 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.XmlNode[]; /** - * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. + * Gets a `XmlNode` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `XmlNode` object. */ - whole = "Whole", + getItem(index: number): Word.XmlNode; /** - * The starting point of the object. For content control, it's the point after the opening tag. + * Returns an individual `XmlNode` object in a collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the XML node to retrieve. */ - start = "Start", + getItemAt(index: number): Word.XmlNode; /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - end = "End", + load(options?: Word.Interfaces.XmlNodeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.XmlNodeCollection; /** - * For content control only. It's the point before the opening tag. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - before = "Before", + load(propertyNames?: string | string[]): Word.XmlNodeCollection; /** - * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - after = "After", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.XmlNodeCollection; /** - * The range between 'Start' and 'End'. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - content = "Content", + track(): Word.XmlNodeCollection; + /** + * 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.XmlNodeCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNodeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.XmlNodeCollectionData; } /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.setValidationError} method. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum LocationRelation { + interface XmlNodeSetValidationErrorOptions { /** - * Indicates that this instance and the range are in different sub-documents. + * If provided, specifies whether the validation error should be cleared automatically. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unrelated = "Unrelated", + clearedAutomatically?: boolean; /** - * Indicates that this instance and the range represent the same range. + * If provided, specifies the error text to display for the validation error. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - equal = "Equal", + errorText?: string; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class XmlNode 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; /** - * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Gets the attributes for this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - containsStart = "ContainsStart", + readonly attributes: Word.XmlNodeCollection; /** - * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Gets the child elements of this XML node. Returns an empty collection if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - containsEnd = "ContainsEnd", + readonly childNodes: Word.XmlNodeCollection; /** - * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contains = "Contains", + readonly firstChild: Word.XmlNode; /** - * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideStart = "InsideStart", + readonly lastChild: Word.XmlNode; /** - * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideEnd = "InsideEnd", + readonly nextSibling: Word.XmlNode; /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Gets the parent document of this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + readonly ownerDocument: Word.Document; /** - * Indicates that this instance occurs before, and is adjacent to, the range. + * Gets the parent element of this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - adjacentBefore = "AdjacentBefore", + readonly parentNode: Word.XmlNode; /** - * Indicates that this instance starts before the range and overlaps the range's first character. + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - overlapsBefore = "OverlapsBefore", + readonly previousSibling: Word.XmlNode; /** - * Indicates that this instance occurs before the range. + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + readonly range: Word.Range; /** - * Indicates that this instance occurs after, and is adjacent to, the range. + * Gets the name of the element without any prefix. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - adjacentAfter = "AdjacentAfter", + readonly baseName: string; /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - overlapsAfter = "OverlapsAfter", + readonly hasChildNodes: boolean; /** - * Indicates that this instance occurs after the range. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum BorderLocation { + readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + readonly namespaceUri: string; /** + * Gets the type of node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + readonly nodeType: Word.XmlNodeType | "Element" | "Attribute"; /** + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", + nodeValue: string; /** + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + placeholderText: string; /** + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideHorizontal = "InsideHorizontal", + text: string; /** + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideVertical = "InsideVertical", + readonly validationErrorText: string; /** + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom"; /** + * Copies this XML node, excluding XML markup, to the Clipboard. For attribute nodes, copies only the attribute value as text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outside = "Outside", + copy(): void; /** + * Removes this XML node from the document and places it on the Clipboard. For attribute nodes, removes the attribute from its parent element and copies only the attribute value as text to the clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - all = "All", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum CellPaddingLocation { + cut(): void; /** + * Deletes the XML node from the XML document. For element nodes, removes the entire element and its content; for attribute nodes, removes the attribute from its parent element. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + delete(): void; /** + * Removes a child element from this XML node. This method has no effect if the node type is `attribute` (since attribute nodes have no child elements). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param childElement The child element to remove. */ - left = "Left", + removeChild(childElement: Word.XmlNode): void; /** + * Returns all the child elements that match the XPath parameter, in the order in which they appear within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. Configuration options for the XPath search. + * @returns A collection of XML nodes that match the XPath expression. */ - bottom = "Bottom", + selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection; /** + * Returns the first child element that matches the XPath parameter within this XML node. Returns `null` if the node type is `attribute` (since attribute nodes have no child elements to search). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xPath The XPath expression to evaluate. + * @param options Optional. Configuration options for the XPath search. + * @returns The first XML node that matches the XPath expression, or `null` if no match is found. */ - right = "Right", - } - /** - * Represents the width of a style's border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum BorderWidth { + selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode; /** - * None width. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param status The validation status to set. + * @param options Optional. Configuration options for setting the validation error. */ - none = "None", + setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * 0.25 point. + * Changes the validation error text displayed to a user for this XML node and whether to force Word to report the node as invalid. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param status The validation status to set. + * @param options Optional. Configuration options for setting the validation error. */ - pt025 = "Pt025", + setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void; /** - * 0.50 point. + * Validates this XML node against the XML schemas that are attached to the document. May not be meaningful for attribute nodes. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pt050 = "Pt050", + validate(): void; /** - * 0.75 point. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt075 = "Pt075", + load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode; /** - * 1.00 point. This is the default. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt100 = "Pt100", + load(propertyNames?: string | string[]): Word.XmlNode; /** - * 1.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt150 = "Pt150", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.XmlNode; /** - * 2.25 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt225 = "Pt225", + track(): Word.XmlNode; /** - * 3.00 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - pt300 = "Pt300", + untrack(): Word.XmlNode; /** - * 4.50 points. - * @remarks - * [Api set: WordApiDesktop 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.XmlNode` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.XmlNodeData`) that contains shallow copies of any loaded child properties from the original object. */ - pt450 = "Pt450", + toJSON(): Word.Interfaces.XmlNodeData; + } + /** + * Specifies the type of an XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum XmlNodeType { /** - * 6.00 points. + * Element node. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pt600 = "Pt600", + element = "Element", /** - * Mixed width. + * Attribute node. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + attribute = "Attribute", } /** + * Specifies the validation status of an XML node. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BorderType { + enum XmlValidationStatus { /** + * The node is valid. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + ok = "Ok", /** + * The node has a custom (user-defined) validation error. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + custom = "Custom", + } + /** + * Specifies the level of an XML node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum XmlNodeLevel { /** + * Inline node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - single = "Single", + inline = "Inline", /** + * Paragraph node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - double = "Double", + paragraph = "Paragraph", /** + * Row node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + row = "Row", /** + * Cell node level. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashed = "Dashed", + cell = "Cell", + } + /** + * Specifies which Quick Style set to apply to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ApplyQuickStyleSet { /** + * Resets the Quick Style to the style set in use when the document was opened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashed = "DotDashed", + sessionStart = "SessionStart", /** + * Resets the Quick Style to the style set from the template, if any. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dot2Dashed = "Dot2Dashed", + template = "Template", + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectNodes} and {@link Word.Document| Document.selectNodes} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectNodesOptions { /** + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - triple = "Triple", + fastSearchSkippingTextNodes?: boolean; /** + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickSmall = "ThinThickSmall", + prefixMapping?: string; + } + /** + * Provides configuration options for the {@link Word.XmlNode | XmlNode.selectSingleNode} and {@link Word.Document| Document.selectSingleNode} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectSingleNodeOptions { /** + * If provided, specifies whether to skip text nodes in the search. The default value is `false`. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinSmall = "ThickThinSmall", + fastSearchSkippingTextNodes?: boolean; /** + * If provided, specifies the prefix mapping for the XPath expression. The default value is "" (empty string). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinSmall = "ThinThickThinSmall", + prefixMapping?: string; + } + /** + * Specifies the screen size for web page preview and HTML export optimization. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ScreenSize { /** + * Screen resolution 544x376 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickMed = "ThinThickMed", + size544x376 = "Size544x376", /** + * Screen resolution 640x480 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinMed = "ThickThinMed", + size640x480 = "Size640x480", /** + * Screen resolution 720x512 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinMed = "ThinThickThinMed", + size720x512 = "Size720x512", /** + * Screen resolution 800x600 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickLarge = "ThinThickLarge", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - thickThinLarge = "ThickThinLarge", + size800x600 = "Size800x600", /** + * Screen resolution 1024x768 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinLarge = "ThinThickThinLarge", + size1024x768 = "Size1024x768", /** + * Screen resolution 1152x882 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + size1152x882 = "Size1152x882", /** + * Screen resolution 1152x900 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleWave = "DoubleWave", + size1152x900 = "Size1152x900", /** + * Screen resolution 1280x1024 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashedSmall = "DashedSmall", + size1280x1024 = "Size1280x1024", /** + * Screen resolution 1600x1200 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashDotStroked = "DashDotStroked", + size1600x1200 = "Size1600x1200", /** + * Screen resolution 1800x1440 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - threeDEmboss = "ThreeDEmboss", + size1800x1440 = "Size1800x1440", /** + * Screen resolution 1920x1200 pixels. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - threeDEngrave = "ThreeDEngrave", + size1920x1200 = "Size1920x1200", } /** + * Specifies the target web browser for HTML export and web page optimization. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum VerticalAlignment { + enum TargetBrowser { /** + * Browser version 3. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + v3 = "V3", /** + * Browser version 4. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + v4 = "V4", /** + * Microsoft Internet Explorer 4. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - center = "Center", + ie4 = "Ie4", /** + * Microsoft Internet Explorer 5. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", + ie5 = "Ie5", + /** + * Microsoft Internet Explorer 6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ie6 = "Ie6", } /** - * Represents the type of baseline alignment. - * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BaselineAlignment { + class HtmlDivision 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; + readonly htmlDivisions: Word.HtmlDivisionCollection; /** - * Represents top baseline alignment. + * Gets a `Range` object that represents the portion of a document that's contained in this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + readonly range: Word.Range; /** - * Represents center baseline alignment. + * Specifies the left indent value (in points) for this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + leftIndent: number; /** - * Represents baseline alignment. + * Specifies the right indent (in points) for this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseline = "Baseline", + rightIndent: number; /** - * Represents Far East 50% baseline alignment. + * Specifies the amount of spacing (in points) after this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast50 = "FarEast50", + spaceAfter: number; /** - * Represents automatic baseline alignment. + * Specifies the spacing (in points) before this HTML division. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum ListLevelType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - bullet = "Bullet", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - number = "Number", + spaceBefore: number; /** + * Deletes this HTML division. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum ListBullet { + delete(): void; /** + * Returns an `HtmlDivision` object that represents a parent division of the current HTML division. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param levelsUp Optional. The number of levels to go up to retrieve the parent division. */ - custom = "Custom", + htmlDivisionParent(levelsUp?: number): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - solid = "Solid", + load(options?: Word.Interfaces.HtmlDivisionLoadOptions): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - hollow = "Hollow", + load(propertyNames?: string | string[]): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - square = "Square", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - diamonds = "Diamonds", + track(): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - arrow = "Arrow", + untrack(): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionData`) that contains shallow copies of any loaded child properties from the original object. */ - checkmark = "Checkmark", + toJSON(): Word.Interfaces.HtmlDivisionData; } /** + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListNumbering { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - none = "None", + class HtmlDivisionCollection 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.HtmlDivision[]; /** + * Returns an `HtmlDivision` object from the collection based on the specified index. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the `HtmlDivision` to retrieve. */ - arabic = "Arabic", + getItemAt(index: number): Word.HtmlDivision; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - upperRoman = "UpperRoman", + load(options?: Word.Interfaces.HtmlDivisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - lowerRoman = "LowerRoman", + load(propertyNames?: string | string[]): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - upperLetter = "UpperLetter", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.HtmlDivisionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HtmlDivisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HtmlDivisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - lowerLetter = "LowerLetter", + toJSON(): Word.Interfaces.HtmlDivisionCollectionData; } /** - * Represents the built-in style in a Word document. + * Calendar types. * * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BuiltInStyleName { + enum CalendarType { /** - * Mixed styles or other style not in this list. + * Western calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - other = "Other", + western = "Western", /** - * Reset character and paragraph style to default. + * Arabic calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + arabic = "Arabic", /** + * Hebrew calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading1 = "Heading1", + hebrew = "Hebrew", /** + * Taiwan calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading2 = "Heading2", + taiwan = "Taiwan", /** + * Japanese calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading3 = "Heading3", + japan = "Japan", /** + * Thai calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading4 = "Heading4", + thai = "Thai", /** + * Korean calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading5 = "Heading5", + korean = "Korean", /** + * Saka Era calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading6 = "Heading6", + sakaEra = "SakaEra", /** + * Transliterated English calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading7 = "Heading7", + translitEnglish = "TranslitEnglish", /** + * Transliterated French calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading8 = "Heading8", + translitFrench = "TranslitFrench", /** + * Umm al-Qura calendar type. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heading9 = "Heading9", + umalqura = "Umalqura", + } + /** + * Date storage formats for {@link Word.DatePickerContentControl}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlDateStorageFormat { /** - * Table-of-content level 1. + * Stores the date as text. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc1 = "Toc1", + text = "Text", /** - * Table-of-content level 2. + * Stores the date as a date object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc2 = "Toc2", + date = "Date", /** - * Table-of-content level 3. + * Stores the date as a date-time object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc3 = "Toc3", + dateTime = "DateTime", + } + /** + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Frame 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; /** - * Table-of-content level 4. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc4 = "Toc4", + readonly borders: Word.BorderUniversalCollection; /** - * Table-of-content level 5. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc5 = "Toc5", + readonly range: Word.Range; /** - * Table-of-content level 6. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc6 = "Toc6", + readonly shading: Word.ShadingUniversal; /** - * Table-of-content level 7. + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc7 = "Toc7", + height: number; /** - * Table-of-content level 8. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc8 = "Toc8", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Table-of-content level 9. + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc9 = "Toc9", + horizontalDistanceFromText: number; /** + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteText = "FootnoteText", + horizontalPosition: number; /** + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - header = "Header", + lockAnchor: boolean; /** + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footer = "Footer", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - caption = "Caption", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteReference = "FootnoteReference", + textWrap: boolean; /** + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnoteReference = "EndnoteReference", + verticalDistanceFromText: number; /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnoteText = "EndnoteText", + verticalPosition: number; /** + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title = "Title", + width: number; /** + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtitle = "Subtitle", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - hyperlink = "Hyperlink", + set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Frame): void; /** + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strong = "Strong", + copy(): void; /** + * Removes the frame from the document and places it on the Clipboard. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - emphasis = "Emphasis", + cut(): void; /** + * Deletes the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noSpacing = "NoSpacing", + delete(): void; /** + * Selects the frame. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listParagraph = "ListParagraph", + select(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - quote = "Quote", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - intenseQuote = "IntenseQuote", + load(propertyNames?: string | string[]): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - subtleEmphasis = "SubtleEmphasis", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - intenseEmphasis = "IntenseEmphasis", + track(): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - subtleReference = "SubtleReference", + untrack(): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. */ - intenseReference = "IntenseReference", + toJSON(): Word.Interfaces.FrameData; + } + /** + * Represents the collection of {@link Word.Frame} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class FrameCollection 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.Frame[]; /** + * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where the frame will be added. + * @returns A `Frame` object that represents the new frame. */ - bookTitle = "BookTitle", + add(range: Word.Range): Word.Frame; /** + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bibliography = "Bibliography", + delete(): void; /** - * Table-of-content heading. + * Gets a `Frame` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `Frame` object. */ - tocHeading = "TocHeading", + getItem(index: number): Word.Frame; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableGrid = "TableGrid", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable1 = "PlainTable1", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable2 = "PlainTable2", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable3 = "PlainTable3", + track(): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - plainTable4 = "PlainTable4", + untrack(): Word.FrameCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - plainTable5 = "PlainTable5", + toJSON(): Word.Interfaces.FrameCollectionData; + } + /** + * Represents a document library version. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class DocumentLibraryVersion 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 any optional comments associated with this version of the shared document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableGridLight = "TableGridLight", + readonly comments: string; /** + * Gets the date and time at which this version of the shared document was last saved to the server. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light = "GridTable1Light", + readonly modified: any; /** + * Gets the name of the user who last saved this version of the shared document to the server. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + readonly modifiedBy: string; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + track(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + untrack(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. */ - gridTable2 = "GridTable2", + toJSON(): Word.Interfaces.DocumentLibraryVersionData; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class DocumentLibraryVersionCollection 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.DocumentLibraryVersion[]; /** + * Gets a `DocumentLibraryVersion` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `DocumentLibraryVersion` object. */ - gridTable2_Accent1 = "GridTable2_Accent1", + getItem(index: number): Word.DocumentLibraryVersion; /** + * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable2_Accent2 = "GridTable2_Accent2", + isVersioningEnabled(): OfficeExtension.ClientResult; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent3 = "GridTable2_Accent3", + load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent4 = "GridTable2_Accent4", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent5 = "GridTable2_Accent5", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable2_Accent6 = "GridTable2_Accent6", + track(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - gridTable3 = "GridTable3", + untrack(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - gridTable3_Accent1 = "GridTable3_Accent1", + toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + } + /** + * Represents the possible change tracking modes. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingMode { /** + * ChangeTracking is turned off. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent2 = "GridTable3_Accent2", + off = "Off", /** + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent3 = "GridTable3_Accent3", + trackAll = "TrackAll", /** + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent4 = "GridTable3_Accent4", + 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.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent5 = "GridTable3_Accent5", + original = "Original", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - gridTable3_Accent6 = "GridTable3_Accent6", + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4 = "GridTable4", + unknown = "Unknown", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent1 = "GridTable4_Accent1", + normal = "Normal", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent2 = "GridTable4_Accent2", + added = "Added", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4_Accent3 = "GridTable4_Accent3", + deleted = "Deleted", + } + /** + * TrackedChange type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + enum TrackedChangeType { /** + * No revision. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent4 = "GridTable4_Accent4", + none = "None", /** + * Add change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent5 = "GridTable4_Accent5", + added = "Added", /** + * Delete change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable4_Accent6 = "GridTable4_Accent6", + deleted = "Deleted", /** + * Format change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable5Dark = "GridTable5Dark", + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + footnote = "Footnote", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + endnote = "Endnote", + } + /** + * Provides information about the type of a raised event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventType { /** + * ContentControlDeleted represents the event that the content control has been deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + contentControlDeleted = "ContentControlDeleted", /** + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + contentControlSelectionChanged = "ContentControlSelectionChanged", /** + * ContentControlDataChanged represents the event that the data in the content control have been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + contentControlDataChanged = "ContentControlDataChanged", /** + * ContentControlAdded represents the event a content control has been added to the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + contentControlAdded = "ContentControlAdded", /** + * Represents that one or more comments were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful = "GridTable6Colorful", + commentDeleted = "CommentDeleted", /** + * Represents that a comment was selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + commentSelected = "CommentSelected", /** + * Represents that a comment was deselected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + commentDeselected = "CommentDeselected", /** + * Represents that a comment or its reply was changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + commentChanged = "CommentChanged", /** + * Represents that one or more new comments were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + commentAdded = "CommentAdded", /** + * Represents that a content control has been entered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + contentControlEntered = "ContentControlEntered", /** + * Represents that a content control has been exited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + contentControlExited = "ContentControlExited", /** + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful = "GridTable7Colorful", + paragraphAdded = "ParagraphAdded", /** + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + paragraphChanged = "ParagraphChanged", /** + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + paragraphDeleted = "ParagraphDeleted", /** + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + annotationClicked = "AnnotationClicked", /** + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + annotationHovered = "AnnotationHovered", /** + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + annotationInserted = "AnnotationInserted", /** + * Represents that one or more annotations were deleted from the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + annotationRemoved = "AnnotationRemoved", /** + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - listTable1Light = "ListTable1Light", + annotationPopupAction = "AnnotationPopupAction", + } + /** + * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventSource { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + local = "Local", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + remote = "Remote", + } + /** + * Provides information about the content control that raised contentControlAdded event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlAddedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDataChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlDataChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2 = "ListTable2", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent1 = "ListTable2_Accent1", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDeleted event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlDeletedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent2 = "ListTable2_Accent2", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent3 = "ListTable2_Accent3", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent4 = "ListTable2_Accent4", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - listTable2_Accent5 = "ListTable2_Accent5", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlEntered event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlEnteredEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable2_Accent6 = "ListTable2_Accent6", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3 = "ListTable3", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent1 = "ListTable3_Accent1", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlExited event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlExitedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent2 = "ListTable3_Accent2", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent3 = "ListTable3_Accent3", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable3_Accent4 = "ListTable3_Accent4", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class DropCap 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 distance (in points) between the dropped capital letter and the paragraph text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable3_Accent5 = "ListTable3_Accent5", + readonly distanceFromText: number; /** + * Gets the name of the font for the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable3_Accent6 = "ListTable3_Accent6", + readonly fontName: string; /** + * Gets the height (in lines) of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4 = "ListTable4", + readonly linesToDrop: number; /** + * Gets the position of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent1 = "ListTable4_Accent1", + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** + * Removes the dropped capital letter formatting. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent2 = "ListTable4_Accent2", + clear(): void; /** + * Formats the first character in the specified paragraph as a dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable4_Accent3 = "ListTable4_Accent3", + enable(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent4 = "ListTable4_Accent4", + load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent5 = "ListTable4_Accent5", + load(propertyNames?: string | string[]): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable4_Accent6 = "ListTable4_Accent6", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable5Dark = "ListTable5Dark", + track(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + untrack(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + toJSON(): Word.Interfaces.DropCapData; + } + /** + * Provides information about the content control that raised contentControlSelectionChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlSelectionChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the paragraphs that raised the paragraphAdded event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphAddedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful = "ListTable6Colorful", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphChangedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphDeleted event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphDeletedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "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. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listTable7Colorful = "ListTable7Colorful", + uniqueLocalIds: string[]; + } + /** + * Provides information about the comments that raised the comment event. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CommentEventArgs { /** + * Represents how the comment changed event is triggered. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** + * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + commentDetails: Word.CommentDetail[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + } + /** + * A structure for the ID and reply IDs of this comment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CommentDetail { /** + * Represents the ID of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + id: string; /** + * Represents the IDs of the replies to this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + replyIds: string[]; } /** + * Represents how the comments in the event were changed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum DocumentPropertyType { + enum CommentChangeType { /** + * No comment changed event is triggered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - string = "String", + none = "none", /** + * A comment was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - number = "Number", + edited = "edited", /** + * A comment was resolved. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date = "Date", + resolved = "resolved", /** + * A comment was reopened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boolean = "Boolean", + reopened = "reopened", + /** + * A reply was added. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replyAdded = "replyAdded", + /** + * A reply was deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replyDeleted = "replyDeleted", + /** + * A reply was edited. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replyEdited = "replyEdited", } /** - * Represents the type of style. + * Specifies supported content control types and subtypes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - enum StyleType { + enum ContentControlType { /** - * Represents that the style is a character style. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - character = "Character", + unknown = "Unknown", /** - * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - list = "List", + richTextInline = "RichTextInline", /** - * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - paragraph = "Paragraph", + richTextParagraphs = "RichTextParagraphs", /** - * Represents that the style is a table style. + * Contains a whole cell. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - table = "Table", - } - /** - * Represents the outline levels. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum OutlineLevel { + richTextTableCell = "RichTextTableCell", /** - * Represents outline level 1. + * Contains a whole row. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel1 = "OutlineLevel1", + richTextTableRow = "RichTextTableRow", /** - * Represents outline level 2. + * Contains a whole table. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel2 = "OutlineLevel2", + richTextTable = "RichTextTable", /** - * Represents outline level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel3 = "OutlineLevel3", + plainTextInline = "PlainTextInline", /** - * Represents outline level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel4 = "OutlineLevel4", + plainTextParagraph = "PlainTextParagraph", /** - * Represents outline level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel5 = "OutlineLevel5", + picture = "Picture", /** - * Represents outline level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel6 = "OutlineLevel6", + buildingBlockGallery = "BuildingBlockGallery", /** - * Represents outline level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel7 = "OutlineLevel7", + checkBox = "CheckBox", /** - * Represents outline level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel8 = "OutlineLevel8", + comboBox = "ComboBox", /** - * Represents outline level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel9 = "OutlineLevel9", + dropDownList = "DropDownList", /** - * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevelBodyText = "OutlineLevelBodyText", - } - /** - * Specifies the close behavior for `Document.close`. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum CloseBehavior { + datePicker = "DatePicker", /** - * Saves the changes before closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - save = "Save", + repeatingSection = "RepeatingSection", /** - * Discard the possible changes when closing the document. + * Identifies a rich text content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - skipSave = "SkipSave", - } - /** - * Specifies the save behavior for `Document.save`. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SaveBehavior { + richText = "RichText", /** - * Saves the document without prompting the user. If it's a new document, - it will be saved with the default name or specified name in the default location. * @remarks * [Api set: WordApi 1.1] */ - save = "Save", + plainText = "PlainText", /** - * Displays the "Save As" dialog to the user if the document hasn't been saved. - Won't take effect if the document was previously saved. * @remarks * [Api set: WordApi 1.1] */ - prompt = "Prompt", + group = "Group", } /** - * Represents the type of Field. + * ContentControl appearance. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] + * + * Content control appearance options are BoundingBox, Tags, or Hidden. */ - enum FieldType { + enum ContentControlAppearance { /** - * Represents that the field type is Add-in. + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - addin = "Addin", + boundingBox = "BoundingBox", /** - * Represents that the field type is AddressBlock. + * Represents a content control shown as start and end markers. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - addressBlock = "AddressBlock", + tags = "Tags", /** - * Represents that the field type is Advance. + * Represents a content control that isn't shown. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - advance = "Advance", + hidden = "Hidden", + } + /** + * Content control level types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlLevel { /** - * Represents that the field type is Ask. + * Represents an inline content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ask = "Ask", + inline = "Inline", /** - * Represents that the field type is Author. + * Represents a paragraph-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author = "Author", + paragraph = "Paragraph", /** - * Represents that the field type is AutoText. + * Represents a row-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoText = "AutoText", + row = "Row", /** - * Represents that the field type is AutoTextList. + * Represents a cell-level content control. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoTextList = "AutoTextList", + cell = "Cell", + } + /** + * Represents the state of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlState { /** - * Represents that the field type is Barcode. + * Error state. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - barCode = "BarCode", + error = "Error", /** - * Represents that the field type is Bibliography. + * Warning state. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bibliography = "Bibliography", + warning = "Warning", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { /** - * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - bidiOutline = "BidiOutline", + mixed = "Mixed", /** - * Represents that the field type is Citation. + * No underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - citation = "Citation", + none = "None", /** - * Represents that the field type is Comments. + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - comments = "Comments", + hidden = "Hidden", /** - * Represents that the field type is Compare. + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - compare = "Compare", + dotLine = "DotLine", /** - * Represents that the field type is CreateDate. + * A single underline. This is the default value. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - createDate = "CreateDate", + single = "Single", /** - * Represents that the field type is Data. + * Only underline individual words. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data = "Data", + word = "Word", /** - * Represents that the field type is Database. + * A double underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - database = "Database", + double = "Double", /** - * Represents that the field type is Date. + * A single thick underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - date = "Date", + thick = "Thick", /** - * Represents that the field type is DisplayBarcode. + * A dotted underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - displayBarcode = "DisplayBarcode", + dotted = "Dotted", /** - * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - docProperty = "DocProperty", + dottedHeavy = "DottedHeavy", /** - * Represents that the field type is DocumentVariable. + * A single dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - docVariable = "DocVariable", + dashLine = "DashLine", /** - * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - editTime = "EditTime", + dashLineHeavy = "DashLineHeavy", /** - * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - embedded = "Embedded", + dashLineLong = "DashLineLong", /** - * Represents that the field type is Equation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - eq = "EQ", + dashLineLongHeavy = "DashLineLongHeavy", /** - * Represents that the field type is Expression. + * An alternating dot-dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - expression = "Expression", + dotDashLine = "DotDashLine", /** - * Represents that the field type is FileName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fileName = "FileName", + dotDashLineHeavy = "DotDashLineHeavy", /** - * Represents that the field type is FileSize. + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fileSize = "FileSize", + twoDotDashLine = "TwoDotDashLine", /** - * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - fillIn = "FillIn", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** - * Represents that the field type is FormCheckbox. + * A single wavy underline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formCheckbox = "FormCheckbox", + wave = "Wave", /** - * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formDropdown = "FormDropdown", + waveHeavy = "WaveHeavy", /** - * Represents that the field type is FormText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - formText = "FormText", + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { /** - * Represents that the field type is GotoButton. + * Page break at the insertion point. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - gotoButton = "GotoButton", + page = "Page", /** - * Represents that the field type is GreetingLine. + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - greetingLine = "GreetingLine", + next = "Next", /** - * Represents that the field type is Hyperlink. + * Section break on next page. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - hyperlink = "Hyperlink", + sectionNext = "SectionNext", /** - * Represents that the field type is If. + * New section without a corresponding page break. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - if = "If", + sectionContinuous = "SectionContinuous", /** - * Represents that the field type is Import. + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - import = "Import", + sectionEven = "SectionEven", /** - * Represents that the field type is Include. + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - include = "Include", + sectionOdd = "SectionOdd", /** - * Represents that the field type is IncludePicture. + * Line break. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - includePicture = "IncludePicture", + line = "Line", + } + /** + * The insertion location types. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is "Before" or "After", the new content will be outside of the modified object. + * If the location is "Start" or "End", the new content will be included as part of the modified object. + */ + enum InsertLocation { /** - * Represents that the field type is IncludeText. + * Add content before the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - includeText = "IncludeText", + before = "Before", /** - * Represents that the field type is Index. + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - index = "Index", + after = "After", /** - * Represents that the field type is Information. + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - info = "Info", + start = "Start", /** - * Represents that the field type is Keywords. + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - keywords = "Keywords", + end = "End", /** - * Represents that the field type is LastSavedBy. + * Replace the contents of the current object. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - lastSavedBy = "LastSavedBy", + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** - * Represents that the field type is Link. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - link = "Link", + mixed = "Mixed", /** - * Represents that the field type is ListNumber. + * Unknown alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - listNum = "ListNum", + unknown = "Unknown", /** - * Represents that the field type is MacroButton. + * Alignment to the left. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - macroButton = "MacroButton", + left = "Left", /** - * Represents that the field type is MergeBarcode. + * Alignment to the center. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeBarcode = "MergeBarcode", + centered = "Centered", /** - * Represents that the field type is MergeField. + * Alignment to the right. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeField = "MergeField", + right = "Right", /** - * Represents that the field type is MergeRecord. + * Fully justified alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeRec = "MergeRec", + justified = "Justified", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { /** - * Represents that the field type is MergeSequence. + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - mergeSeq = "MergeSeq", + primary = "Primary", /** - * Represents that the field type is Next. + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - next = "Next", + firstPage = "FirstPage", /** - * Represents that the field type is NextIf. + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - nextIf = "NextIf", + evenPages = "EvenPages", + } + /** + * Represents the types of body objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BodyType { /** - * Represents that the field type is NoteReference. + * Unknown body type. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - noteRef = "NoteRef", + unknown = "Unknown", /** - * Represents that the field type is NumberOfCharacters. + * Main document body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numChars = "NumChars", + mainDoc = "MainDoc", /** - * Represents that the field type is NumberOfPages. + * Section body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numPages = "NumPages", + section = "Section", /** - * Represents that the field type is NumberOfWords. + * Header body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numWords = "NumWords", + header = "Header", /** - * Represents that the field type is ActiveXControl. + * Footer body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ocx = "OCX", + footer = "Footer", /** - * Represents that the field type is Page. + * Table cell body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - page = "Page", + tableCell = "TableCell", /** - * Represents that the field type is PageReference. + * Footnote body. * @remarks * [Api set: WordApi 1.5] */ - pageRef = "PageRef", + footnote = "Footnote", /** - * Represents that the field type is Print. + * Endnote body. * @remarks * [Api set: WordApi 1.5] */ - print = "Print", + endnote = "Endnote", /** - * Represents that the field type is PrintDate. + * Note body e.g., endnote, footnote. * @remarks * [Api set: WordApi 1.5] */ - printDate = "PrintDate", + noteItem = "NoteItem", /** - * Represents that the field type is Private. + * Shape body. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - private = "Private", + shape = "Shape", + } + /** + * This enum sets where the cursor (insertion point) in the document is after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { /** - * Represents that the field type is Quote. + * The entire range is selected. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - quote = "Quote", + select = "Select", /** - * Represents that the field type is ReferencedDocument. + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - rd = "RD", + start = "Start", /** - * Represents that the field type is Reference. + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - ref = "Ref", + end = "End", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** - * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - revNum = "RevNum", + unsupported = "Unsupported", /** - * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - saveDate = "SaveDate", + undefined = "Undefined", /** - * Represents that the field type is Section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - section = "Section", + bmp = "Bmp", /** - * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - sectionPages = "SectionPages", + jpeg = "Jpeg", /** - * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - seq = "Seq", + gif = "Gif", /** - * Represents that the field type is Set. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - set = "Set", + tiff = "Tiff", /** - * Represents that the field type is Shape. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - shape = "Shape", + png = "Png", /** - * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - skipIf = "SkipIf", + icon = "Icon", /** - * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - styleRef = "StyleRef", + exif = "Exif", /** - * Represents that the field type is Subject. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - subject = "Subject", + wmf = "Wmf", /** - * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - subscriber = "Subscriber", + emf = "Emf", /** - * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - symbol = "Symbol", + pict = "Pict", /** - * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - ta = "TA", + pdf = "Pdf", /** - * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - tc = "TC", - /** - * Represents that the field type is Template. + svg = "Svg", + } + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { + /** + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - template = "Template", + whole = "Whole", /** - * Represents that the field type is Time. + * The starting point of the object. For content control, it's the point after the opening tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - time = "Time", + start = "Start", /** - * Represents that the field type is Title. + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - title = "Title", + end = "End", /** - * Represents that the field type is TableOfAuthorities. + * For content control only. It's the point before the opening tag. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toa = "TOA", + before = "Before", /** - * Represents that the field type is TableOfContents. + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toc = "TOC", + after = "After", /** - * Represents that the field type is UserAddress. + * The range between 'Start' and 'End'. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userAddress = "UserAddress", + content = "Content", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { /** - * Represents that the field type is UserInitials. + * Indicates that this instance and the range are in different sub-documents. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userInitials = "UserInitials", + unrelated = "Unrelated", /** - * Represents that the field type is UserName. + * Indicates that this instance and the range represent the same range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userName = "UserName", + equal = "Equal", /** - * Represents that the field type is IndexEntry. + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - xe = "XE", + containsStart = "ContainsStart", /** - * Represents that the field type is Empty. + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - empty = "Empty", + containsEnd = "ContainsEnd", /** - * Represents the field types not supported by the Office JavaScript API. + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - others = "Others", + contains = "Contains", /** - * Represents that the field type is Undefined. + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - undefined = "Undefined", - } - /** - * Represents the kind of field. Indicates how the field works in relation to updating. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldKind { + insideStart = "InsideStart", /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - none = "None", + insideEnd = "InsideEnd", /** - * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hot = "Hot", + inside = "Inside", /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - warm = "Warm", + adjacentBefore = "AdjacentBefore", /** - * Represents that the field doesn't have a result. + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - cold = "Cold", - } - /** - * Represents the character inserted after the list item mark. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum TrailingCharacter { + overlapsBefore = "OverlapsBefore", /** - * A tab is inserted. + * Indicates that this instance occurs before the range. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingTab = "TrailingTab", + before = "Before", /** - * A space is inserted. Default. + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingSpace = "TrailingSpace", + adjacentAfter = "AdjacentAfter", /** - * No character is inserted. + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingNone = "TrailingNone", + overlapsAfter = "OverlapsAfter", + /** + * Indicates that this instance occurs after the range. + * @remarks + * [Api set: WordApi 1.3] + */ + after = "After", } /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - enum ListBuiltInNumberStyle { - /** - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - none = "None", + enum BorderLocation { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + top = "Top", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperRoman = "UpperRoman", + left = "Left", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerRoman = "LowerRoman", + bottom = "Bottom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperLetter = "UpperLetter", + right = "Right", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerLetter = "LowerLetter", + insideHorizontal = "InsideHorizontal", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinal = "Ordinal", + insideVertical = "InsideVertical", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - cardinalText = "CardinalText", + inside = "Inside", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinalText = "OrdinalText", + outside = "Outside", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanji = "Kanji", + all = "All", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiDigit = "KanjiDigit", + top = "Top", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueoHalfWidth = "AiueoHalfWidth", + left = "Left", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - irohaHalfWidth = "IrohaHalfWidth", + bottom = "Bottom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicFullWidth = "ArabicFullWidth", + right = "Right", + } + /** + * Represents the width of a style's border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum BorderWidth { /** + * None width. * @remarks * [Api set: WordApiDesktop 1.1] */ - kanjiTraditional = "KanjiTraditional", + none = "None", /** + * 0.25 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - kanjiTraditional2 = "KanjiTraditional2", + pt025 = "Pt025", /** + * 0.50 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - numberInCircle = "NumberInCircle", + pt050 = "Pt050", /** + * 0.75 point. * @remarks * [Api set: WordApiDesktop 1.1] */ - aiueo = "Aiueo", + pt075 = "Pt075", /** + * 1.00 point. This is the default. * @remarks * [Api set: WordApiDesktop 1.1] */ - iroha = "Iroha", + pt100 = "Pt100", /** + * 1.50 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - arabicLZ = "ArabicLZ", + pt150 = "Pt150", /** + * 2.25 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - bullet = "Bullet", + pt225 = "Pt225", /** + * 3.00 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - ganada = "Ganada", + pt300 = "Pt300", /** + * 4.50 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - chosung = "Chosung", + pt450 = "Pt450", /** + * 6.00 points. * @remarks * [Api set: WordApiDesktop 1.1] */ - gbnum1 = "GBNum1", + pt600 = "Pt600", /** + * Mixed width. * @remarks * [Api set: WordApiDesktop 1.1] */ - gbnum2 = "GBNum2", + mixed = "Mixed", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum3 = "GBNum3", + mixed = "Mixed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum4 = "GBNum4", + none = "None", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac1 = "Zodiac1", + single = "Single", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac2 = "Zodiac2", + double = "Double", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac3 = "Zodiac3", + dotted = "Dotted", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum1 = "TradChinNum1", + dashed = "Dashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum2 = "TradChinNum2", + dotDashed = "DotDashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum3 = "TradChinNum3", + dot2Dashed = "Dot2Dashed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum4 = "TradChinNum4", + triple = "Triple", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum1 = "SimpChinNum1", + thinThickSmall = "ThinThickSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum2 = "SimpChinNum2", + thickThinSmall = "ThickThinSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum3 = "SimpChinNum3", + thinThickThinSmall = "ThinThickThinSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum4 = "SimpChinNum4", + thinThickMed = "ThinThickMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaRead = "HanjaRead", + thickThinMed = "ThickThinMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + thinThickThinMed = "ThinThickThinMed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hangul = "Hangul", + thinThickLarge = "ThinThickLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanja = "Hanja", + thickThinLarge = "ThickThinLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew1 = "Hebrew1", + thinThickThinLarge = "ThinThickThinLarge", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic1 = "Arabic1", + wave = "Wave", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew2 = "Hebrew2", + doubleWave = "DoubleWave", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic2 = "Arabic2", + dashedSmall = "DashedSmall", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter1 = "HindiLetter1", + dashDotStroked = "DashDotStroked", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter2 = "HindiLetter2", + threeDEmboss = "ThreeDEmboss", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiArabic = "HindiArabic", + threeDEngrave = "ThreeDEngrave", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum VerticalAlignment { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiCardinalText = "HindiCardinalText", + mixed = "Mixed", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiLetter = "ThaiLetter", + top = "Top", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiArabic = "ThaiArabic", + center = "Center", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiCardinalText = "ThaiCardinalText", + bottom = "Bottom", + } + /** + * Represents the type of baseline alignment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BaselineAlignment { /** + * Represents top baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vietCardinalText = "VietCardinalText", + top = "Top", /** + * Represents center baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lowercaseRussian = "LowercaseRussian", + center = "Center", /** + * Represents baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uppercaseRussian = "UppercaseRussian", + baseline = "Baseline", /** + * Represents Far East 50% baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lowercaseGreek = "LowercaseGreek", + farEast50 = "FarEast50", /** + * Represents automatic baseline alignment. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uppercaseGreek = "UppercaseGreek", + auto = "Auto", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListLevelType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ2 = "ArabicLZ2", + bullet = "Bullet", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ3 = "ArabicLZ3", + number = "Number", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ4 = "ArabicLZ4", + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseTurkish = "LowercaseTurkish", + custom = "Custom", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseTurkish = "UppercaseTurkish", + solid = "Solid", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseBulgarian = "LowercaseBulgarian", + hollow = "Hollow", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - uppercaseBulgarian = "UppercaseBulgarian", + square = "Square", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - pictureBullet = "PictureBullet", + diamonds = "Diamonds", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - legal = "Legal", + arrow = "Arrow", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - legalLZ = "LegalLZ", + checkmark = "Checkmark", } /** - * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. - * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - enum ShadingTextureType { + enum ListNumbering { /** - * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalDown = "DarkDiagonalDown", + none = "None", /** - * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkDiagonalUp = "DarkDiagonalUp", + arabic = "Arabic", /** - * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkGrid = "DarkGrid", + upperRoman = "UpperRoman", /** - * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkHorizontal = "DarkHorizontal", + lowerRoman = "LowerRoman", /** - * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkTrellis = "DarkTrellis", + upperLetter = "UpperLetter", /** - * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - darkVertical = "DarkVertical", - /** - * Represents light diagonal-down texture. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - lightDiagonalDown = "LightDiagonalDown", + lowerLetter = "LowerLetter", + } + /** + * Represents the built-in style in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. + */ + enum BuiltInStyleName { /** - * Represents light diagonal-up texture. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightDiagonalUp = "LightDiagonalUp", + other = "Other", /** - * Represents light horizontal-cross texture. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightGrid = "LightGrid", + normal = "Normal", /** - * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightHorizontal = "LightHorizontal", + heading1 = "Heading1", /** - * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightTrellis = "LightTrellis", + heading2 = "Heading2", /** - * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lightVertical = "LightVertical", + heading3 = "Heading3", /** - * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + heading4 = "Heading4", /** - * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent10 = "Percent10", + heading5 = "Heading5", /** - * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent12Pt5 = "Percent12Pt5", + heading6 = "Heading6", /** - * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent15 = "Percent15", + heading7 = "Heading7", /** - * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent20 = "Percent20", + heading8 = "Heading8", /** - * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent25 = "Percent25", + heading9 = "Heading9", /** - * Represents 30 percent texture. + * Table-of-content level 1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent30 = "Percent30", + toc1 = "Toc1", /** - * Represents 35 percent texture. + * Table-of-content level 2. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent35 = "Percent35", + toc2 = "Toc2", /** - * Represents 37.5 percent texture. + * Table-of-content level 3. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent37Pt5 = "Percent37Pt5", + toc3 = "Toc3", /** - * Represents 40 percent texture. + * Table-of-content level 4. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent40 = "Percent40", + toc4 = "Toc4", /** - * Represents 45 percent texture. + * Table-of-content level 5. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent45 = "Percent45", + toc5 = "Toc5", /** - * Represents 5 percent texture. + * Table-of-content level 6. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent5 = "Percent5", + toc6 = "Toc6", /** - * Represents 50 percent texture. + * Table-of-content level 7. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent50 = "Percent50", + toc7 = "Toc7", /** - * Represents 55 percent texture. + * Table-of-content level 8. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent55 = "Percent55", + toc8 = "Toc8", /** - * Represents 60 percent texture. + * Table-of-content level 9. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent60 = "Percent60", + toc9 = "Toc9", /** - * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent62Pt5 = "Percent62Pt5", + footnoteText = "FootnoteText", /** - * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent65 = "Percent65", + header = "Header", /** - * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent70 = "Percent70", + footer = "Footer", /** - * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent75 = "Percent75", + caption = "Caption", /** - * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent80 = "Percent80", + footnoteReference = "FootnoteReference", /** - * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent85 = "Percent85", + endnoteReference = "EndnoteReference", /** - * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent87Pt5 = "Percent87Pt5", + endnoteText = "EndnoteText", /** - * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent90 = "Percent90", + title = "Title", /** - * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - percent95 = "Percent95", + subtitle = "Subtitle", /** - * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - solid = "Solid", - } - /** - * Specifies the target document for displaying document comparison differences. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum CompareTarget { + hyperlink = "Hyperlink", /** - * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetCurrent = "CompareTargetCurrent", + strong = "Strong", /** - * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetSelected = "CompareTargetSelected", + emphasis = "Emphasis", /** - * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - compareTargetNew = "CompareTargetNew", - } - /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImportedStylesConflictBehavior { + noSpacing = "NoSpacing", /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ignore = "Ignore", + listParagraph = "ListParagraph", /** - * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - overwrite = "Overwrite", + quote = "Quote", /** - * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - createNew = "CreateNew", - } - /** - * Represents the shape type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeType { + intenseQuote = "IntenseQuote", /** - * Unsupported shape type. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - unsupported = "Unsupported", + subtleEmphasis = "SubtleEmphasis", /** - * Text box shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - textBox = "TextBox", + intenseEmphasis = "IntenseEmphasis", /** - * Geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - geometricShape = "GeometricShape", + subtleReference = "SubtleReference", /** - * Group shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - group = "Group", + intenseReference = "IntenseReference", /** - * Picture shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - picture = "Picture", + bookTitle = "BookTitle", /** - * Canvas shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - canvas = "Canvas", - } - /** - * 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: WordApiDesktop 1.2] - */ - enum RelativeHorizontalPosition { + bibliography = "Bibliography", /** - * Relative to margin. + * Table-of-content heading. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + tocHeading = "TocHeading", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + tableGrid = "TableGrid", /** - * Relative to column. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - column = "Column", + plainTable1 = "PlainTable1", /** - * Relative to character. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - character = "Character", + plainTable2 = "PlainTable2", /** - * Relative to left margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftMargin = "LeftMargin", + plainTable3 = "PlainTable3", /** - * Relative to right margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightMargin = "RightMargin", + plainTable4 = "PlainTable4", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + plainTable5 = "PlainTable5", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - 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: WordApiDesktop 1.2] - */ - enum RelativeVerticalPosition { + tableGridLight = "TableGridLight", /** - * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + gridTable1Light = "GridTable1Light", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Relative to paragraph. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - paragraph = "Paragraph", + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Relative to line. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - line = "Line", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topMargin = "TopMargin", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bottomMargin = "BottomMargin", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the horizontal or vertical size 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: WordApiDesktop 1.2] - */ - enum RelativeSize { + gridTable2 = "GridTable2", /** - * Relative to margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - margin = "Margin", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * Relative to page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable2_Accent2 = "GridTable2_Accent2", /** - * Relative to top margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topMargin = "TopMargin", + gridTable2_Accent3 = "GridTable2_Accent3", /** - * Relative to bottom margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bottomMargin = "BottomMargin", + gridTable2_Accent4 = "GridTable2_Accent4", /** - * Relative to inside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - insideMargin = "InsideMargin", + gridTable2_Accent5 = "GridTable2_Accent5", /** - * Relative to outside margin. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - outsideMargin = "OutsideMargin", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum GeometricShapeType { + gridTable2_Accent6 = "GridTable2_Accent6", /** - * Line inverse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lineInverse = "LineInverse", + gridTable3 = "GridTable3", /** - * Triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - triangle = "Triangle", + gridTable3_Accent1 = "GridTable3_Accent1", /** - * Right triangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightTriangle = "RightTriangle", + gridTable3_Accent2 = "GridTable3_Accent2", /** - * Rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rectangle = "Rectangle", + gridTable3_Accent3 = "GridTable3_Accent3", /** - * Diamond geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - diamond = "Diamond", + gridTable3_Accent4 = "GridTable3_Accent4", /** - * Parallelogram geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - parallelogram = "Parallelogram", + gridTable3_Accent5 = "GridTable3_Accent5", /** - * Trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - trapezoid = "Trapezoid", + gridTable3_Accent6 = "GridTable3_Accent6", /** - * Non-isosceles trapezoid geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + gridTable4 = "GridTable4", /** - * Pentagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pentagon = "Pentagon", + gridTable4_Accent1 = "GridTable4_Accent1", /** - * Hexagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - hexagon = "Hexagon", + gridTable4_Accent2 = "GridTable4_Accent2", /** - * Heptagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heptagon = "Heptagon", + gridTable4_Accent3 = "GridTable4_Accent3", /** - * Octagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - octagon = "Octagon", + gridTable4_Accent4 = "GridTable4_Accent4", /** - * Decagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - decagon = "Decagon", + gridTable4_Accent5 = "GridTable4_Accent5", /** - * Dodecagon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - dodecagon = "Dodecagon", + gridTable4_Accent6 = "GridTable4_Accent6", /** - * Star 4-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star4 = "Star4", + gridTable5Dark = "GridTable5Dark", /** - * Star 5-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star5 = "Star5", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** - * Star 6-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star6 = "Star6", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** - * Star 7-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star7 = "Star7", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** - * Star 8-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star8 = "Star8", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** - * Star 10-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star10 = "Star10", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** - * Star 12-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star12 = "Star12", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** - * Star 16-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star16 = "Star16", + gridTable6Colorful = "GridTable6Colorful", /** - * Star 24-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star24 = "Star24", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** - * Star 32-point geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - star32 = "Star32", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** - * Round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - roundRectangle = "RoundRectangle", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** - * Round one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round1Rectangle = "Round1Rectangle", + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** - * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round2SameRectangle = "Round2SameRectangle", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** - * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** - * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snipRoundRectangle = "SnipRoundRectangle", + gridTable7Colorful = "GridTable7Colorful", /** - * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip1Rectangle = "Snip1Rectangle", + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** - * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip2SameRectangle = "Snip2SameRectangle", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** - * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** - * Plaque geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - plaque = "Plaque", + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** - * Ellipse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - ellipse = "Ellipse", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** - * Teardrop geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - teardrop = "Teardrop", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** - * Home plate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - homePlate = "HomePlate", + listTable1Light = "ListTable1Light", /** - * Chevron geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - chevron = "Chevron", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** - * Pie wedge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pieWedge = "PieWedge", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** - * Pie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pie = "Pie", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** - * Block arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - blockArc = "BlockArc", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** - * Donut geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - donut = "Donut", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** - * No smoking geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - noSmoking = "NoSmoking", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** - * Right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightArrow = "RightArrow", + listTable2 = "ListTable2", /** - * Left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftArrow = "LeftArrow", + listTable2_Accent1 = "ListTable2_Accent1", /** - * Up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upArrow = "UpArrow", + listTable2_Accent2 = "ListTable2_Accent2", /** - * Down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - downArrow = "DownArrow", + listTable2_Accent3 = "ListTable2_Accent3", /** - * Striped right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - stripedRightArrow = "StripedRightArrow", + listTable2_Accent4 = "ListTable2_Accent4", /** - * Notched right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - notchedRightArrow = "NotchedRightArrow", + listTable2_Accent5 = "ListTable2_Accent5", /** - * Bent up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bentUpArrow = "BentUpArrow", + listTable2_Accent6 = "ListTable2_Accent6", /** - * Left-right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightArrow = "LeftRightArrow", + listTable3 = "ListTable3", /** - * Up-down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upDownArrow = "UpDownArrow", + listTable3_Accent1 = "ListTable3_Accent1", /** - * Left-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftUpArrow = "LeftUpArrow", + listTable3_Accent2 = "ListTable3_Accent2", /** - * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightUpArrow = "LeftRightUpArrow", + listTable3_Accent3 = "ListTable3_Accent3", /** - * Quad arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - quadArrow = "QuadArrow", + listTable3_Accent4 = "ListTable3_Accent4", /** - * Left arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftArrowCallout = "LeftArrowCallout", + listTable3_Accent5 = "ListTable3_Accent5", /** - * Right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightArrowCallout = "RightArrowCallout", + listTable3_Accent6 = "ListTable3_Accent6", /** - * Up arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upArrowCallout = "UpArrowCallout", + listTable4 = "ListTable4", /** - * Down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - downArrowCallout = "DownArrowCallout", + listTable4_Accent1 = "ListTable4_Accent1", /** - * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightArrowCallout = "LeftRightArrowCallout", + listTable4_Accent2 = "ListTable4_Accent2", /** - * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - upDownArrowCallout = "UpDownArrowCallout", + listTable4_Accent3 = "ListTable4_Accent3", /** - * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - quadArrowCallout = "QuadArrowCallout", + listTable4_Accent4 = "ListTable4_Accent4", /** - * Bent arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bentArrow = "BentArrow", + listTable4_Accent5 = "ListTable4_Accent5", /** - * U-turn arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - uturnArrow = "UturnArrow", + listTable4_Accent6 = "ListTable4_Accent6", /** - * Circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - circularArrow = "CircularArrow", + listTable5Dark = "ListTable5Dark", /** - * Left circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftCircularArrow = "LeftCircularArrow", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** - * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRightCircularArrow = "LeftRightCircularArrow", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** - * Curved right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedRightArrow = "CurvedRightArrow", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** - * Curved left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedLeftArrow = "CurvedLeftArrow", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** - * Curved up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedUpArrow = "CurvedUpArrow", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** - * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - curvedDownArrow = "CurvedDownArrow", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** - * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - swooshArrow = "SwooshArrow", + listTable6Colorful = "ListTable6Colorful", /** - * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - cube = "Cube", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** - * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - can = "Can", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** - * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lightningBolt = "LightningBolt", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** - * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - heart = "Heart", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** - * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - sun = "Sun", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** - * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - moon = "Moon", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** - * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - smileyFace = "SmileyFace", + listTable7Colorful = "ListTable7Colorful", /** - * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - irregularSeal1 = "IrregularSeal1", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** - * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - irregularSeal2 = "IrregularSeal2", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** - * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - foldedCorner = "FoldedCorner", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** - * Bevel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - bevel = "Bevel", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** - * Frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - frame = "Frame", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** - * Half frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - halfFrame = "HalfFrame", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** - * Corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - corner = "Corner", + string = "String", /** - * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - diagonalStripe = "DiagonalStripe", + number = "Number", /** - * Chord geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - chord = "Chord", + date = "Date", /** - * Arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - arc = "Arc", + boolean = "Boolean", + } + /** + * Specifies the type of item to print from a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutItem { /** - * Left bracket geometric shape. + * Represents printing the document content. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftBracket = "LeftBracket", + documentContent = "DocumentContent", /** - * Right bracket geometric shape. + * Represents printing the document properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightBracket = "RightBracket", + properties = "Properties", /** - * Left brace geometric shape. + * Represents printing the comments. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftBrace = "LeftBrace", + comments = "Comments", /** - * Right brace geometric shape. + * Represents printing the markup. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightBrace = "RightBrace", + markup = "Markup", /** - * Bracket pair geometric shape. + * Represents printing the styles. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bracketPair = "BracketPair", + styles = "Styles", /** - * Brace pair geometric shape. + * Represents printing the AutoText entries. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bracePair = "BracePair", + autoTextEntries = "AutoTextEntries", /** - * Callout 1 geometric shape. + * Represents printing the key assignments. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout1 = "Callout1", + keyAssignments = "KeyAssignments", /** - * Callout 2 geometric shape. + * Represents printing the envelope. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout2 = "Callout2", + envelope = "Envelope", /** - * Callout 3 geometric shape. + * Represents printing the document with markup. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - callout3 = "Callout3", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies which pages to print based on odd or even page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutPages { /** - * Accent callout 1 geometric shape. + * Represents printing all pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout1 = "AccentCallout1", + all = "All", /** - * Accent callout 2 geometric shape. + * Represents printing only odd-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout2 = "AccentCallout2", + oddOnly = "OddOnly", /** - * Accent callout 3 geometric shape. + * Represents printing only even-numbered pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentCallout3 = "AccentCallout3", + evenOnly = "EvenOnly", + } + /** + * Specifies the range of content to print from a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PrintOutRange { /** - * Border callout 1 geometric shape. + * Represents printing the entire document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout1 = "BorderCallout1", + allDocument = "AllDocument", /** - * Border callout 2 geometric shape. + * Represents printing the current selection. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout2 = "BorderCallout2", + selection = "Selection", /** - * Border callout 3 geometric shape. + * Represents printing the current page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borderCallout3 = "BorderCallout3", + currentPage = "CurrentPage", /** - * Accent border callout 1 geometric shape. + * Represents printing a range from one page to another. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout1 = "AccentBorderCallout1", + fromTo = "FromTo", /** - * Accent border callout 2 geometric shape. + * Represents printing specific ranges of pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout2 = "AccentBorderCallout2", + rangeOfPages = "RangeOfPages", + } + /** + * Specifies the export format for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportFormat { /** - * Accent border callout 3 geometric shape. + * PDF export format. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - accentBorderCallout3 = "AccentBorderCallout3", + pdf = "Pdf", /** - * Wedge rectangle callout geometric shape. + * XPS export format. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeRectCallout = "WedgeRectCallout", + xps = "Xps", + } + /** + * Specifies the export item type for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportItem { /** - * Wedge rounded rectangle callout geometric shape. + * Exports document content only. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeRRectCallout = "WedgeRRectCallout", + documentContent = "DocumentContent", /** - * Wedge ellipse callout geometric shape. + * Exports document with markup (annotations). * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wedgeEllipseCallout = "WedgeEllipseCallout", + documentWithMarkup = "DocumentWithMarkup", + } + /** + * Specifies the optimization target for document export. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportOptimizeFor { /** - * Cloud callout geometric shape. + * Optimizes for print. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cloudCallout = "CloudCallout", + print = "Print", /** - * Cloud geometric shape. + * Optimizes for on-screen display. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cloud = "Cloud", + onScreen = "OnScreen", + } + /** + * Specifies the range to export from a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportRange { /** - * Ribbon geometric shape. + * Exports the entire document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ribbon = "Ribbon", + allDocument = "AllDocument", /** - * Ribbon 2 geometric shape. + * Exports the current selection. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ribbon2 = "Ribbon2", + selection = "Selection", /** - * Ellipse ribbon geometric shape. + * Exports the current page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ellipseRibbon = "EllipseRibbon", + currentPage = "CurrentPage", /** - * Ellipse ribbon 2 geometric shape. + * Exports a specific range of pages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ellipseRibbon2 = "EllipseRibbon2", + fromTo = "FromTo", + } + /** + * Specifies the type of bookmarks to create during export. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExportCreateBookmarks { /** - * Left-right ribbon geometric shape. + * Do not create bookmarks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRightRibbon = "LeftRightRibbon", + none = "None", /** - * Vertical scroll geometric shape. + * Creates bookmarks from headings. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalScroll = "VerticalScroll", + headings = "Headings", /** - * Horizontal scroll geometric shape. + * Creates bookmarks from Word bookmarks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalScroll = "HorizontalScroll", + wordBookmarks = "WordBookmarks", + } + /** + * Specifies the source of formatting to use during document operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum UseFormattingFrom { /** - * Wave geometric shape. + * Represents using formatting from the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + current = "Current", /** - * Double wave geometric shape. + * Represents using formatting from the selected document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleWave = "DoubleWave", + selected = "Selected", /** - * Plus geometric shape. + * Represents prompting the user for formatting preferences. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plus = "Plus", + prompt = "Prompt", + } + /** + * Indicates the auto macros that can run automatically in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoMacro { /** - * Flow chart process geometric shape. + * Indicates that the macro runs automatically when Word starts. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartProcess = "FlowChartProcess", + startWord = "StartWord", /** - * Flow chart decision geometric shape. + * Indicates that the macro runs automatically when a new document is created. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDecision = "FlowChartDecision", + new = "New", /** - * Flow chart input-output geometric shape. + * Indicates that the macro runs automatically when the document is opened. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartInputOutput = "FlowChartInputOutput", + open = "Open", /** - * Flow chart predefined process geometric shape. + * Indicates that the macro runs automatically when the document is closed. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + close = "Close", /** - * Flow chart internal storage geometric shape. + * Indicates that the macro runs automatically when the document is saved. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartInternalStorage = "FlowChartInternalStorage", + exit = "Exit", /** - * Flow chart document geometric shape. + * Indicates that the macro runs automatically when the document is synchronized. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDocument = "FlowChartDocument", + sync = "Sync", + } + /** + * Document statistic types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Statistic { /** - * Flow chart multidocument geometric shape. + * Words in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMultidocument = "FlowChartMultidocument", + words = "Words", /** - * Flow chart terminator geometric shape. + * Lines in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartTerminator = "FlowChartTerminator", + lines = "Lines", /** - * Flow chart preparation geometric shape. + * Pages in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPreparation = "FlowChartPreparation", + pages = "Pages", /** - * Flow chart manual input geometric shape. + * Characters in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartManualInput = "FlowChartManualInput", + characters = "Characters", /** - * Flow chart manual operation geometric shape. + * Paragraphs in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartManualOperation = "FlowChartManualOperation", + paragraphs = "Paragraphs", /** - * Flow chart connector geometric shape. + * Characters including spaces. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartConnector = "FlowChartConnector", + charactersWithSpaces = "CharactersWithSpaces", /** - * Flow chart punched card geometric shape. + * Far East (DBCS) characters. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPunchedCard = "FlowChartPunchedCard", + farEastCharacters = "FarEastCharacters", + } + /** + * Specifies the type of document information to remove. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RemoveDocInfoType { /** - * Flow chart punched tape geometric shape. + * Comments in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartPunchedTape = "FlowChartPunchedTape", + comments = "Comments", /** - * Flow chart summing junction geometric shape. + * Revisions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartSummingJunction = "FlowChartSummingJunction", + revisions = "Revisions", /** - * Flow chart OR geometric shape. + * Versions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOr = "FlowChartOr", + versions = "Versions", /** - * Flow chart collate geometric shape. + * Personal information in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartCollate = "FlowChartCollate", + removePersonalInformation = "RemovePersonalInformation", /** - * Flow chart sort geometric shape. + * Email header in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartSort = "FlowChartSort", + emailHeader = "EmailHeader", /** - * Flow chart extract geometric shape. + * Routing slip in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartExtract = "FlowChartExtract", + routingSlip = "RoutingSlip", /** - * Flow chart merge geometric shape. + * Send for review information in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMerge = "FlowChartMerge", + sendForReview = "SendForReview", /** - * Flow chart offline storage geometric shape. + * Document properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + documentProperties = "DocumentProperties", /** - * Flow chart online storage geometric shape. + * Template information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + template = "Template", /** - * Flow chart magnetic tape geometric shape. + * Document workspace properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticTape = "FlowChartMagneticTape", + documentWorkspace = "DocumentWorkspace", /** - * Flow chart magnetic disk geometric shape. + * Ink annotations in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + inkAnnotations = "InkAnnotations", /** - * Flow chart magnetic drum geometric shape. + * Document server properties. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + documentServerProperties = "DocumentServerProperties", /** - * Flow chart display geometric shape. + * Document management policy. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDisplay = "FlowChartDisplay", + documentManagementPolicy = "DocumentManagementPolicy", /** - * Flow chart delay geometric shape. + * Content type information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartDelay = "FlowChartDelay", + contentType = "ContentType", /** - * Flow chart alternate process geometric shape. + * Taskpane web extensions. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + taskpaneWebExtensions = "TaskpaneWebExtensions", /** - * Flow chart off-page connector geometric shape. + * At mentions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + atMentions = "AtMentions", /** - * Action button blank geometric shape. + * Document tasks. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBlank = "ActionButtonBlank", + documentTasks = "DocumentTasks", /** - * Action button home geometric shape. + * Document intelligence information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonHome = "ActionButtonHome", + documentIntelligence = "DocumentIntelligence", /** - * Action button help geometric shape. + * Comment reactions in the document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonHelp = "ActionButtonHelp", + commentReactions = "CommentReactions", /** - * Action button information geometric shape. + * All document information types. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonInformation = "ActionButtonInformation", + all = "All", + } + /** + * Specifies the version type for document check-in operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CheckInVersionType { /** - * Action button forward next geometric shape. + * Represents a minor version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonForwardNext = "ActionButtonForwardNext", + minor = "Minor", /** - * Action button back previous geometric shape. + * Represents a major version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + major = "Major", /** - * Action button end geometric shape. + * Represents an overwrite version check-in. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonEnd = "ActionButtonEnd", + overwrite = "Overwrite", + } + /** + * Specifies the target document for merge operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MergeTarget { /** - * Action button beginning geometric shape. + * Represents merging into the selected document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonBeginning = "ActionButtonBeginning", + selected = "Selected", /** - * Action button return geometric shape. + * Represents merging into the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonReturn = "ActionButtonReturn", + current = "Current", /** - * Action button document geometric shape. + * Represents merging into a new document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonDocument = "ActionButtonDocument", + new = "New", + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkSpelling} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentCheckSpellingOptions { /** - * Action button sound geometric shape. + * If provided, specifies whether to always suggest spelling corrections. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonSound = "ActionButtonSound", + alwaysSuggest?: boolean; /** - * Action button movie geometric shape. + * If provided, specifies the custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - actionButtonMovie = "ActionButtonMovie", + customDictionary?: string; /** - * Gear 6 geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gear6 = "Gear6", + customDictionary10?: string; /** - * Gear 9 geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gear9 = "Gear9", + customDictionary2?: string; /** - * Funnel geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - funnel = "Funnel", + customDictionary3?: string; /** - * Math plus geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathPlus = "MathPlus", + customDictionary4?: string; /** - * Math minus geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathMinus = "MathMinus", + customDictionary5?: string; /** - * Math multiply geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathMultiply = "MathMultiply", + customDictionary6?: string; /** - * Math divide geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathDivide = "MathDivide", + customDictionary7?: string; /** - * Math equal geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathEqual = "MathEqual", + customDictionary8?: string; /** - * Math not equal geometric shape. + * If provided, specifies an additional custom dictionary to use for spell checking. The default value is "" (empty string). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mathNotEqual = "MathNotEqual", + customDictionary9?: string; /** - * Corner tabs geometric shape. + * If provided, specifies whether to ignore uppercase words during spell checking. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cornerTabs = "CornerTabs", + ignoreUppercase?: boolean; + } + /** + * Provides configuration options for the {@link Word.Document | Document.range} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentRangeOptions { /** - * Square tabs geometric shape. + * If provided, specifies the ending character position. The default value is the end of the document. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - squareTabs = "SquareTabs", + end?: number; /** - * Plaque tabs geometric shape. + * If provided, specifies the starting character position. The default value is `0`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plaqueTabs = "PlaqueTabs", + start?: number; + } + /** + * Represents the options for the {@link Word.Selection | Selection.goTo} and {@link Word.Document| Document.goTo} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface GoToOptions { /** - * Chart X geometric shape. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chartX = "ChartX", + count?: number; /** - * Chart star geometric shape. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chartStar = "ChartStar", + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * Chart plus geometric shape. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - chartPlus = "ChartPlus", + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + /** + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } /** - * Specifies a shape's fill type. + * Provides configuration options for the {@link Word.Document | Document.printOut} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeFillType { + interface DocumentPrintOutOptions { /** - * No fill. + * If provided, specifies the printer name. The default value is an empty string. This argument is available only in Microsoft Office Macintosh Edition. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noFill = "NoFill", + activePrinterMacGX?: string; /** - * Solid fill. + * If provided, specifies whether to append to an existing file. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - solid = "Solid", + append?: boolean; /** - * Gradient fill. + * If provided, specifies whether to print in the background. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gradient = "Gradient", + background?: boolean; /** - * Pattern fill. + * If provided, specifies whether to collate pages. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pattern = "Pattern", + collate?: boolean; /** - * Picture fill. + * If provided, specifies the number of copies to print. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + copies?: number; /** - * Texture fill. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture = "Texture", + from?: number; /** - * Mixed fill. + * If provided, specifies the item to print. The default value is `PrintOutItem.documentContent`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", - } - /** - * Specifies the vertical alignment for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextVerticalAlignment { + item?: Word.PrintOutItem | "DocumentContent" | "Properties" | "Comments" | "Markup" | "Styles" | "AutoTextEntries" | "KeyAssignments" | "Envelope" | "DocumentWithMarkup"; /** - * Anchor the text at the top of the bounding rectangle. + * If provided, specifies whether to manually duplex print. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + manualDuplexPrint?: boolean; /** - * Anchor the text at the middle of the bounding rectangle. + * If provided, specifies the name of the output file. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - middle = "Middle", + outputFileName?: string; /** - * Anchor the text at the bottom of the bounding rectangle. + * If provided, specifies the page order. The default value is `PrintOutPages.allPages`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", - } - /** - * Specifies the orientation for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextOrientation { + pageType?: Word.PrintOutPages | "All" | "OddOnly" | "EvenOnly"; /** - * No orientation, such as in a new geometric shape. + * If provided, specifies specific pages to print. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + pages?: string; /** - * Horizontal text. + * If provided, specifies whether to print to file. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontal = "Horizontal", + printToFile?: boolean; /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * If provided, specifies the zoom column setting. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eastAsianVertical = "EastAsianVertical", + printZoomColumn?: number; /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * If provided, specifies the paper height for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is `0` (use original height). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vertical270 = "Vertical270", + printZoomPaperHeight?: number; /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * If provided, specifies the paper width for printing in twips (20 twips = 1 point; 72 points = 1 inch). The default value is `0` (use original width). + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - vertical = "Vertical", + printZoomPaperWidth?: number; /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * If provided, specifies the zoom row setting. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + printZoomRow?: number; /** - * A combination of automatic orientation is used. + * If provided, specifies the range to print. The default value is `allDocument`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + range?: Word.PrintOutRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo" | "RangeOfPages"; + /** + * If provided, specifies the ending page number. The default value is the last page of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + to?: number; } /** - * Determines the type of automatic sizing allowed. + * Provides configuration options for the {@link Word.Document | Document.exportAsFixedFormat} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeAutoSize { + interface DocumentExportAsFixedFormatOptions { /** - * No autosizing. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + bitmapMissingFonts?: boolean; /** - * The text is adjusted to fit the shape. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textToFitShape = "TextToFitShape", + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * The shape is adjusted to fit the text. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeToFitText = "ShapeToFitText", + documentStructureTags?: boolean; /** - * A combination of automatic sizing schemes are used. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", - } - /** - * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapType { + fixedFormatExtensionClassPointer?: any; /** - * Places the shape in line with text. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inline = "Inline", + from?: number; /** - * Wraps text squarely around the shape. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - square = "Square", + includeDocProps?: boolean; /** - * Wraps text close to the shape. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tight = "Tight", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Wraps text around and through the shape. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - through = "Through", + keepInformationRightsManagement?: boolean; /** - * Places text above and below the shape. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topBottom = "TopBottom", + openAfterExport?: boolean; /** - * Places shape behind text. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - behind = "Behind", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Places shape in front of text. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - front = "Front", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; + /** + * If provided, specifies the ending page number. The default value is the last page of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + to?: number; + /** + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useIso19005_1?: boolean; } /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * Provides configuration options for the {@link Word.Document | Document.followHyperlink} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeTextWrapSide { + interface DocumentFollowHyperlinkOptions { /** - * Has no wrap side property, such as those for inline shapes. + * If provided, specifies whether to add the link to the browsing history. The default value is `true`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + addHistory?: boolean; /** - * Both left and right sides of the shape. + * If provided, specifies the hyperlink address to follow. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - both = "Both", + address?: string; /** - * Left side of the shape only. + * If provided, specifies additional information to pass with the request. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + extraInfo?: string; /** - * Right side of the shape only. + * If provided, specifies header information for the HTTP request. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + headerInfo?: string; /** - * Side of the shape that's farther from the respective page margin. + * If provided, specifies the HTTP method to use for the request. The default value is "GET". + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - largest = "Largest", - } - /** - * Specifies the scale size type of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleType { + httpMethod?: string; /** - * Scale from current size of the shape. + * If provided, specifies whether to open the link in a new window. The default value is `false`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - currentSize = "CurrentSize", + newWindow?: boolean; /** - * Scale from original size of the shape. It only works for pictures. + * If provided, specifies the sub-address within the document. The default value is an empty string. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - originalSize = "OriginalSize", + subAddress?: string; } /** - * Specifies which part of the shape retains its position when the shape is scaled. + * Provides configuration options for the {@link Word.Document | Document.countNumberedItems} method. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ShapeScaleFrom { - /** - * Scale from the top left corner of the shape. - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - scaleFromTopLeft = "ScaleFromTopLeft", + interface DocumentCountNumberedItemsOptions { /** - * Scale from the center of the shape. + * If provided, specifies the level of numbering to count. If omitted, all levels are counted. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleFromMiddle = "ScaleFromMiddle", + level?: number; /** - * Scale from the bottom right corner of the shape. + * If provided, specifies the type of numbered items to count. The default value is `allNumbers`. + * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleFromBottomRight = "ScaleFromBottomRight", + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; } /** - * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * Provides configuration options for the {@link Word.Document | Document.merge} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FrameSizeRule { + interface DocumentMergeOptions { /** - * The height or width is set according to the height or width of the item in the frame. + * If provided, specifies whether to add the merged document to recent files. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + addToRecentFiles?: boolean; /** - * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. + * If provided, specifies whether to detect format changes during the merge. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + detectFormatChanges?: boolean; /** - * The height or width is set to an exact value specified by the `height` property or `width` property. + * If provided, specifies the target of the merge operation. The default value is `current`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exact = "Exact", + mergeTarget?: Word.MergeTarget | "Selected" | "Current" | "New"; + /** + * If provided, specifies the source of formatting to use in the merge. The default value is `current`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useFormattingFrom?: Word.UseFormattingFrom | "Current" | "Selected" | "Prompt"; } /** - * Specifies the border style for an object. + * Provides configuration options for the {@link Word.Document | Document.sendForReview} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BorderLineStyle { + interface DocumentSendForReviewOptions { /** - * No line style. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + includeAttachment?: boolean; /** - * Single line style. + * If provided, specifies the recipients of the review request. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + recipients?: string; /** - * Dotted line style. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dot = "Dot", + showMessage?: boolean; /** - * Dashed line style with small gaps. + * If provided, specifies the subject of the review email. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashSmallGap = "DashSmallGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.replyWithChanges} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentReplyWithChangesOptions { /** - * Dashed line style with large gaps. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLargeGap = "DashLargeGap", + includeAttachment?: boolean; /** - * Dash-dot line style. + * If provided, specifies the recipients of the reply. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + recipients?: string; /** - * Dash-dot-dot line style. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + showMessage?: boolean; /** - * Double line style. + * If provided, specifies the subject of the reply email. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.endReview} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentEndReviewOptions { /** - * Triple line style. + * If provided, specifies whether to include the document as an attachment. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triple = "Triple", + includeAttachment?: boolean; /** - * Thin-thick line style with small gaps. + * If provided, specifies the recipients to notify when ending the review. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickSmallGap = "ThinThickSmallGap", + recipients?: string; /** - * Thick-thin line style with small gaps. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinSmallGap = "ThickThinSmallGap", + showMessage?: boolean; /** - * Thin-thick-thin line style with small gaps. + * If provided, specifies the subject of the notification email. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinSmallGap = "ThinThickThinSmallGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.sendFaxOverInternet} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentSendFaxOverInternetOptions { /** - * Thin-thick line style with medium gaps. + * If provided, specifies the recipients of the fax. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickMedGap = "ThinThickMedGap", + recipients?: string; /** - * Thick-thin line style with medium gaps. + * If provided, specifies whether to show the message before sending. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinMedGap = "ThickThinMedGap", + showMessage?: boolean; /** - * Thin-thick-thin line style with medium gaps. + * If provided, specifies the subject of the fax. The default value is "" (empty string). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinMedGap = "ThinThickThinMedGap", + subject?: string; + } + /** + * Provides configuration options for the {@link Word.Document | Document.protect} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentProtectOptions { /** - * Thin-thick line style with large gaps. + * If provided, specifies whether to enforce style lock restrictions. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickLargeGap = "ThinThickLargeGap", + enforceStyleLock?: boolean; /** - * Thick-thin line style with large gaps. + * If provided, specifies whether to reset form fields when protecting the document. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThinLargeGap = "ThickThinLargeGap", + noReset?: boolean; /** - * Thin-thick-thin line style with large gaps. + * If provided, specifies the password to apply for document protection. The default value is an empty string. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThickThinLargeGap = "ThinThickThinLargeGap", + password?: string; /** - * Single wavy line style. + * If provided, specifies whether to use Information Rights Management (IRM). The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleWavy = "SingleWavy", + useInformationRightsManagement?: boolean; + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkInWithVersion} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentCheckInWithVersionOptions { /** - * Double wavy line style. + * If provided, specifies a comment for the check-in operation. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleWavy = "DoubleWavy", + comment?: string; /** - * Dash-dot stroked line style. + * If provided, specifies whether to make the document public after check-in. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotStroked = "DashDotStroked", + makePublic?: boolean; /** - * Embossed 3D line style. + * If provided, specifies whether to save changes before checking in. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss3D = "Emboss3D", + saveChanges?: boolean; /** - * Engraved 3D line style. + * If provided, specifies the version type for the check-in. The default value is `minorVersion`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave3D = "Engrave3D", + versionType?: Word.CheckInVersionType | "Minor" | "Major" | "Overwrite"; + } + /** + * Provides configuration options for the {@link Word.Document | Document.checkIn} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentCheckInOptions { /** - * Outset line style. + * If provided, specifies a comment for the check-in operation. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outset = "Outset", + comment?: string; /** - * Inset line style. + * If provided, specifies whether to make the document public after check-in. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inset = "Inset", + makePublic?: boolean; + /** + * If provided, specifies whether to save changes before checking in. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + saveChanges?: boolean; } /** - * Specifies the width of an object's border. + * Represents the options for exporting a document as a fixed format (PDF or XPS) using the {@link Word.Document | Document.exportAsFixedFormat2} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineWidth { + interface DocumentExportAsFixedFormat2Options { /** - * Represents a line width of 0.25 points. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt025 = "Pt025", + bitmapMissingFonts?: boolean; /** - * Represents a line width of 0.50 points. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt050 = "Pt050", + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * Represents a line width of 0.75 points. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt075 = "Pt075", + documentStructureTags?: boolean; /** - * Represents a line width of 1.00 points. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt100 = "Pt100", + fixedFormatExtClassPtr?: any; /** - * Represents a line width of 1.50 points. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt150 = "Pt150", + from?: number; /** - * Represents a line width of 2.25 points. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt225 = "Pt225", + includeDocProps?: boolean; /** - * Represents a line width of 3.00 points. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt300 = "Pt300", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Represents a line width of 4.50 points. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt450 = "Pt450", + keepInformationRightsManagement?: boolean; /** - * Represents a line width of 6.00 points. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pt600 = "Pt600", - } - /** - * Specifies the graphical page border setting of a page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageBorderArt { + openAfterExport?: boolean; /** - * Represents a border with apple design. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - apples = "Apples", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Represents a border with maple muffin design. + * If provided, specifies whether to optimize for image quality in the exported file. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapleMuffins = "MapleMuffins", + optimizeForImageQuality?: boolean; /** - * Represents a border with cake slice design. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cakeSlice = "CakeSlice", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; /** - * Represents a border with candy corn design. + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - candyCorn = "CandyCorn", + to?: number; /** - * Represents a border with ice cream cone design. + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iceCreamCones = "IceCreamCones", + useIso19005_1?: boolean; + } + /** + * Represents the options for exporting a document as a fixed format (PDF or XPS) with improved tagging using the {@link Word.Document | Document.exportAsFixedFormat3} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentExportAsFixedFormat3Options { /** - * Represents a border with champagne bottle design. + * If provided, specifies whether to bitmap missing fonts. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - champagneBottle = "ChampagneBottle", + bitmapMissingFonts?: boolean; /** - * Represents a border with party glass design. + * If provided, specifies the bookmark creation mode. The default value is `none`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - partyGlass = "PartyGlass", + createBookmarks?: Word.ExportCreateBookmarks | "None" | "Headings" | "WordBookmarks"; /** - * Represents a border with Christmas tree design. + * If provided, specifies whether to include document structure tags. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - christmasTree = "ChristmasTree", + documentStructureTags?: boolean; /** - * Represents a border with trees design. + * If provided, specifies the extension class pointer. The default value is `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trees = "Trees", + fixedFormatExtClassPtr?: any; /** - * Represents a border with palm trees in color. + * If provided, specifies the starting page number. The default value is `1`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - palmsColor = "PalmsColor", + from?: number; /** - * Represents a border with three-color balloons design. + * If provided, specifies to improve export tagging for better accessibility. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloons3Colors = "Balloons3Colors", + improveExportTagging?: boolean; /** - * Represents a border with hot air balloons design. + * If provided, specifies whether to include document properties. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloonsHotAir = "BalloonsHotAir", + includeDocProps?: boolean; /** - * Represents a border with party favor design. + * If provided, specifies the item to export. The default value is `documentContent`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - partyFavor = "PartyFavor", + item?: Word.ExportItem | "DocumentContent" | "DocumentWithMarkup"; /** - * Represents a border with confetti streamers design. + * If provided, specifies whether to keep Information Rights Management (IRM) settings. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiStreamers = "ConfettiStreamers", + keepInformationRightsManagement?: boolean; /** - * Represents a border with hearts design. + * If provided, specifies whether to open the file after export. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hearts = "Hearts", + openAfterExport?: boolean; /** - * Represents a border with heart balloon design. + * If provided, specifies the optimization target for the export. The default value is `print`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heartBalloon = "HeartBalloon", + optimizeFor?: Word.ExportOptimizeFor | "Print" | "OnScreen"; /** - * Represents a border with 3D stars design. + * If provided, specifies whether to optimize for image quality in the exported file. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stars3D = "Stars3D", + optimizeForImageQuality?: boolean; /** - * Represents a border with shadowed stars design. + * If provided, specifies the range to export. The default value is `allDocument`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsShadowed = "StarsShadowed", + range?: Word.ExportRange | "AllDocument" | "Selection" | "CurrentPage" | "FromTo"; /** - * Represents a border with stars design. + * If provided, specifies the ending page number. The default value is the last page of the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stars = "Stars", + to?: number; /** - * Represents a border with sun design. + * If provided, specifies whether to use {@link https://www.iso.org/standard/38920.html | ISO 19005-1 compliance}. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sun = "Sun", + useIso19005_1?: boolean; + } + /** + * Specifies the type of document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentType { /** - * Represents a border with Earth design (variant 2). + * Represents a standard document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earth2 = "Earth2", + document = "Document", /** - * Represents a border with Earth design (variant 1). + * Represents a document template. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earth1 = "Earth1", + template = "Template", /** - * Represents a border with people wearing hats design. + * Represents a frameset document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peopleHats = "PeopleHats", + frameset = "Frameset", + } + /** + * Specifies the kind or purpose of a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentKind { /** - * Represents a border with sombrero design. + * Represents a document with no specified kind. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sombrero = "Sombrero", + notSpecified = "NotSpecified", /** - * Represents a border with pencils design. + * Represents a letter document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pencils = "Pencils", + letter = "Letter", /** - * Represents a border with packages design. + * Represents an email document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - packages = "Packages", + email = "Email", + } + /** + * Represents the file format to use when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FileSaveFormat { /** - * Represents a border with clocks design. + * Represents Microsoft Office Word 97 - 2003 binary file format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clocks = "Clocks", + document = "Document", /** - * Represents a border with firecrackers design. + * Represents Word template format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firecrackers = "Firecrackers", + template = "Template", /** - * Represents a border with rings design. + * Represents Microsoft Windows text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rings = "Rings", + text = "Text", /** - * Represents a border with map pins design. + * Represents Windows text format with line breaks preserved. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapPins = "MapPins", + textLineBreaks = "TextLineBreaks", /** - * Represents a border with confetti design. + * Represents Microsoft DOS text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confetti = "Confetti", + dosText = "DosText", /** - * Represents a border with butterfly creatures design. + * Represents Microsoft DOS text with line breaks preserved. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesButterfly = "CreaturesButterfly", + dosTextLineBreaks = "DosTextLineBreaks", /** - * Represents a border with ladybug creatures design. + * Represents Rich Text Format (RTF). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesLadyBug = "CreaturesLadyBug", + rtf = "Rtf", /** - * Represents a border with fish creatures design. + * Represents Unicode text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesFish = "CreaturesFish", + unicodeText = "UnicodeText", /** - * Represents a border with birds in flight design. + * Represents standard HTML format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - birdsFlight = "BirdsFlight", + html = "Html", /** - * Represents a border with scared cat design. + * Represents Web archive format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaredCat = "ScaredCat", + webArchive = "WebArchive", /** - * Represents a border with bats design. + * Represents filtered HTML format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bats = "Bats", + filteredHtml = "FilteredHtml", /** - * Represents a border with roses flowers design. + * Represents Extensible Markup Language (XML) format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersRoses = "FlowersRoses", + xml = "Xml", /** - * Represents a border with red rose flowers design. + * Represents XML document format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersRedRose = "FlowersRedRose", + xmlDocument = "XmlDocument", /** - * Represents a border with poinsettias flowers design. + * Represents XML document format with macros enabled. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - poinsettias = "Poinsettias", + xmlDocumentMacroEnabled = "XmlDocumentMacroEnabled", /** - * Represents a border with holly design. + * Represents XML template format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - holly = "Holly", + xmlTemplate = "XmlTemplate", /** - * Represents a border with tiny flowers design. + * Represents XML template format with macros enabled. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersTiny = "FlowersTiny", + xmlTemplateMacroEnabled = "XmlTemplateMacroEnabled", /** - * Represents a border with pansy flowers design. + * Represents Word default document file format. For Word, this is the DOCX format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersPansy = "FlowersPansy", + documentDefault = "DocumentDefault", /** - * Represents a border with modern 2 flowers design. + * Represents PDF format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersModern2 = "FlowersModern2", + pdf = "Pdf", /** - * Represents a border with modern 1 flowers design. + * Represents XPS format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersModern1 = "FlowersModern1", + xps = "Xps", /** - * Represents a border with white flowers design. + * Represents Open XML file format saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteFlowers = "WhiteFlowers", + flatXml = "FlatXml", /** - * Represents a border with vine design. + * Represents Open XML file format with macros enabled saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vine = "Vine", + flatXmlMacroEnabled = "FlatXmlMacroEnabled", /** - * Represents a border with daisies flowers design. + * Represents Open XML template format saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersDaisies = "FlowersDaisies", + flatXmlTemplate = "FlatXmlTemplate", /** - * Represents a border with block print flowers design. + * Represents Open XML template format with macros enabled saved as a single XML file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersBlockPrint = "FlowersBlockPrint", + flatXmlTemplateMacroEnabled = "FlatXmlTemplateMacroEnabled", /** - * Represents a border with colored deco arch design. + * Represents OpenDocument Text format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoArchColor = "DecoArchColor", + openDocumentText = "OpenDocumentText", /** - * Represents a border with fans design. + * Represents Strict Open XML document format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fans = "Fans", + strictOpenXmlDocument = "StrictOpenXmlDocument", + } + /** + * Specifies the protection type for a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ProtectionType { /** - * Represents a border with film design. + * No protection is applied to the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - film = "Film", + noProtection = "NoProtection", /** - * Represents a border with lightning design (variant 1). + * Only revisions are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightning1 = "Lightning1", + allowOnlyRevisions = "AllowOnlyRevisions", /** - * Represents a border with compass design. + * Only comments are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compass = "Compass", + allowOnlyComments = "AllowOnlyComments", /** - * Represents a border with double D design. + * Only form fields are allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleD = "DoubleD", + allowOnlyFormFields = "AllowOnlyFormFields", /** - * Represents a border with classical wave design. + * Only reading is allowed in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicalWave = "ClassicalWave", + allowOnlyReading = "AllowOnlyReading", + } + /** + * Represents how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineEndingType { /** - * Represents a border with shadowed squares design. + * Represents carriage return and line feed (Windows standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadowedSquares = "ShadowedSquares", + crlf = "Crlf", /** - * Represents a border with twisted lines design (variant 1). + * Represents carriage return only (Mac classic standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twistedLines1 = "TwistedLines1", + crOnly = "CrOnly", /** - * Represents a border with waveline design. + * Represents line feed only (Unix/Linux standard). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waveline = "Waveline", + lfOnly = "LfOnly", /** - * Represents a border with quadrants design. + * Represents line feed and carriage return. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quadrants = "Quadrants", + lfcr = "Lfcr", /** - * Represents a border with colored checked bar design. + * Represents line separator and paragraph separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarColor = "CheckedBarColor", + lsps = "Lsps", + } + /** + * Specifies the document encoding types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocumentEncoding { /** - * Represents a border with swirligig design. + * Thai encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swirligig = "Swirligig", + thai = "Thai", /** - * Represents a border with push pin note design (variant 1). + * Japanese Shift Japanese Industrial Standards (Shift JIS) encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pushPinNote1 = "PushPinNote1", + japaneseShiftJis = "JapaneseShiftJis", /** - * Represents a border with push pin note design (variant 2). + * Simplified Chinese Guojia Biaozhun Kuozhan (GBK, which means "National Standard Extended" in Chinese) encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pushPinNote2 = "PushPinNote2", + simplifiedChineseGbk = "SimplifiedChineseGbk", /** - * Represents a border with pumpkin design (variant 1). + * Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pumpkin1 = "Pumpkin1", + korean = "Korean", /** - * Represents a border with black eggs design. + * Traditional Chinese Big5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eggsBlack = "EggsBlack", + traditionalChineseBig5 = "TraditionalChineseBig5", /** - * Represents a border with cup design. + * Unicode Little Endian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cup = "Cup", + unicodeLittleEndian = "UnicodeLittleEndian", /** - * Represents a border with gray heart design. + * Unicode Big Endian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heartGray = "HeartGray", + unicodeBigEndian = "UnicodeBigEndian", /** - * Represents a border with gingerbread man design. + * Central European encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gingerbreadMan = "GingerbreadMan", + centralEuropean = "CentralEuropean", /** - * Represents a border with baby pacifier design. + * Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - babyPacifier = "BabyPacifier", + cyrillic = "Cyrillic", /** - * Represents a border with baby rattle design. + * Western encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - babyRattle = "BabyRattle", + western = "Western", /** - * Represents a border with cabins design. + * Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cabins = "Cabins", + greek = "Greek", /** - * Represents a border with funky house design. + * Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - houseFunky = "HouseFunky", + turkish = "Turkish", /** - * Represents a border with black stars design. + * Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsBlack = "StarsBlack", + hebrew = "Hebrew", /** - * Represents a border with snowflakes design. + * Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - snowflakes = "Snowflakes", + arabic = "Arabic", /** - * Represents a border with fancy snowflake design. + * Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - snowflakeFancy = "SnowflakeFancy", + baltic = "Baltic", /** - * Represents a border with skyrocket design. + * Vietnamese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - skyrocket = "Skyrocket", + vietnamese = "Vietnamese", /** - * Represents a border with Seattle design. + * Auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seattle = "Seattle", + autoDetect = "AutoDetect", /** - * Represents a border with music notes design. + * Japanese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - musicNotes = "MusicNotes", + japaneseAutoDetect = "JapaneseAutoDetect", /** - * Represents a border with black palms design. + * Simplified Chinese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - palmsBlack = "PalmsBlack", + simplifiedChineseAutoDetect = "SimplifiedChineseAutoDetect", /** - * Represents a border with maple leaf design. + * Korean auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mapleLeaf = "MapleLeaf", + koreanAutoDetect = "KoreanAutoDetect", /** - * Represents a border with paper clips design. + * Traditional Chinese auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperClips = "PaperClips", + traditionalChineseAutoDetect = "TraditionalChineseAutoDetect", /** - * Represents a border with shorebird tracks design. + * Cyrillic auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shorebirdTracks = "ShorebirdTracks", + cyrillicAutoDetect = "CyrillicAutoDetect", /** - * Represents a border with people design. + * Greek auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - people = "People", + greekAutoDetect = "GreekAutoDetect", /** - * Represents a border with people waving design. + * Arabic auto detect encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peopleWaving = "PeopleWaving", + arabicAutoDetect = "ArabicAutoDetect", /** - * Represents a border with eclipsing squares design (variant 2). + * ISO 8859-1 Latin1 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eclipsingSquares2 = "EclipsingSquares2", + iso88591Latin1 = "Iso88591Latin1", /** - * Represents a border with hypnotic design. + * ISO 8859-2 Central Europe encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hypnotic = "Hypnotic", + iso88592CentralEurope = "Iso88592CentralEurope", /** - * Represents a border with gray diamonds design. + * ISO 8859-3 Latin3 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diamondsGray = "DiamondsGray", + iso88593Latin3 = "Iso88593Latin3", /** - * Represents a border with deco arch design. + * ISO 8859-4 Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoArch = "DecoArch", + iso88594Baltic = "Iso88594Baltic", /** - * Represents a border with deco blocks design. + * ISO 8859-5 Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decoBlocks = "DecoBlocks", + iso88595Cyrillic = "Iso88595Cyrillic", /** - * Represents a border with circles and lines design. + * ISO 8859-6 Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesLines = "CirclesLines", + iso88596Arabic = "Iso88596Arabic", /** - * Represents a border with papyrus design. + * ISO 8859-7 Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + iso88597Greek = "Iso88597Greek", /** - * Represents a border with woodwork design. + * ISO 8859-8 Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - woodwork = "Woodwork", + iso88598Hebrew = "Iso88598Hebrew", /** - * Represents a border with weaving braid design. + * ISO 8859-9 Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingBraid = "WeavingBraid", + iso88599Turkish = "Iso88599Turkish", /** - * Represents a border with weaving ribbon design. + * ISO 8859-15 Latin9 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingRibbon = "WeavingRibbon", + iso885915Latin9 = "Iso885915Latin9", /** - * Represents a border with weaving angles design. + * ISO 8859-8 Hebrew logical encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingAngles = "WeavingAngles", + iso88598HebrewLogical = "Iso88598HebrewLogical", /** - * Represents a border with arched scallops design. + * ISO 2022-JP no halfwidth katakana encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - archedScallops = "ArchedScallops", + iso2022JpNoHalfwidthKatakana = "Iso2022JpNoHalfwidthKatakana", /** - * Represents a border with safari design. + * ISO 2022-JP JIS X 0202-1984 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - safari = "Safari", + iso2022JpJisX02021984 = "Iso2022JpJisX02021984", /** - * Represents a border with Celtic knotwork design. + * ISO 2022-JP JIS X 0201-1989 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - celticKnotwork = "CelticKnotwork", + iso2022JpJisX02011989 = "Iso2022JpJisX02011989", /** - * Represents a border with crazy maze design. + * ISO 2022-KR encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crazyMaze = "CrazyMaze", + iso2022Kr = "Iso2022Kr", /** - * Represents a border with eclipsing squares design (variant 1). + * ISO 2022-CN Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - eclipsingSquares1 = "EclipsingSquares1", + iso2022CnTraditionalChinese = "Iso2022CnTraditionalChinese", /** - * Represents a border with birds design. + * ISO 2022-CN Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - birds = "Birds", + iso2022CnSimplifiedChinese = "Iso2022CnSimplifiedChinese", /** - * Represents a border with teacup and flowers design. + * Mac Roman encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flowersTeacup = "FlowersTeacup", + macRoman = "MacRoman", /** - * Represents a border with northwest design. + * Mac Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - northwest = "Northwest", + macJapanese = "MacJapanese", /** - * Represents a border with southwest design. + * Mac Traditional Chinese Big5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - southwest = "Southwest", + macTraditionalChineseBig5 = "MacTraditionalChineseBig5", /** - * Represents a border with tribal design (variant 6). + * Mac Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal6 = "Tribal6", + macKorean = "MacKorean", /** - * Represents a border with tribal design (variant 4). + * Mac Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal4 = "Tribal4", + macArabic = "MacArabic", /** - * Represents a border with tribal design (variant 3). + * Mac Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal3 = "Tribal3", + macHebrew = "MacHebrew", /** - * Represents a border with tribal design (variant 2). + * Mac Greek1 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal2 = "Tribal2", + macGreek1 = "MacGreek1", /** - * Represents a border with tribal design (variant 5). + * Mac Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal5 = "Tribal5", + macCyrillic = "MacCyrillic", /** - * Represents a border with X illusions design. + * Mac Simplified Chinese GB2312 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xillusions = "XIllusions", + macSimplifiedChineseGb2312 = "MacSimplifiedChineseGb2312", /** - * Represents a border with zany triangles design. + * Mac Romania encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zanyTriangles = "ZanyTriangles", + macRomania = "MacRomania", /** - * Represents a border with pyramids design. + * Mac Ukraine encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pyramids = "Pyramids", + macUkraine = "MacUkraine", /** - * Represents a border with pyramids above design. + * Mac Latin2 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pyramidsAbove = "PyramidsAbove", + macLatin2 = "MacLatin2", /** - * Represents a border with gray confetti design. + * Mac Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiGrays = "ConfettiGrays", + macIcelandic = "MacIcelandic", /** - * Represents a border with outline confetti design. + * Mac Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiOutline = "ConfettiOutline", + macTurkish = "MacTurkish", /** - * Represents a border with white confetti design. + * Mac Croatia encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - confettiWhite = "ConfettiWhite", + macCroatia = "MacCroatia", /** - * Represents a border with mosaic design. + * EBCDIC US-Canada encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mosaic = "Mosaic", + ebcdicUsCanada = "EbcdicUsCanada", /** - * Represents a border with lightning design (variant 2). + * EBCDIC International encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightning2 = "Lightning2", + ebcdicInternational = "EbcdicInternational", /** - * Represents a border with heebie jeebies design. + * EBCDIC Multilingual ROECE Latin2 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heebieJeebies = "HeebieJeebies", + ebcdicMultilingualRoeceLatin2 = "EbcdicMultilingualRoeceLatin2", /** - * Represents a border with light bulb design. + * EBCDIC Greek Modern encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightBulb = "LightBulb", + ebcdicGreekModern = "EbcdicGreekModern", /** - * Represents a border with gradient design. + * EBCDIC Turkish Latin5 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + ebcdicTurkishLatin5 = "EbcdicTurkishLatin5", /** - * Represents a border with triangle party design. + * EBCDIC Germany encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triangleParty = "TriangleParty", + ebcdicGermany = "EbcdicGermany", /** - * Represents a border with twisted lines design (variant 2). + * EBCDIC Denmark-Norway encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twistedLines2 = "TwistedLines2", + ebcdicDenmarkNorway = "EbcdicDenmarkNorway", /** - * Represents a border with moons design. + * EBCDIC Finland-Sweden encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moons = "Moons", + ebcdicFinlandSweden = "EbcdicFinlandSweden", /** - * Represents a border with ovals design. + * EBCDIC Italy encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ovals = "Ovals", + ebcdicItaly = "EbcdicItaly", /** - * Represents a border with double diamonds design. + * EBCDIC Latin America-Spain encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doubleDiamonds = "DoubleDiamonds", + ebcdicLatinAmericaSpain = "EbcdicLatinAmericaSpain", /** - * Represents a border with chain link design. + * EBCDIC United Kingdom encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chainLink = "ChainLink", + ebcdicUnitedKingdom = "EbcdicUnitedKingdom", /** - * Represents a border with triangles design. + * EBCDIC Japanese Katakana Extended encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - triangles = "Triangles", + ebcdicJapaneseKatakanaExtended = "EbcdicJapaneseKatakanaExtended", /** - * Represents a border with tribal design (variant 1). + * EBCDIC France encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tribal1 = "Tribal1", + ebcdicFrance = "EbcdicFrance", /** - * Represents a border with marquee toothed design. + * EBCDIC Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marqueeToothed = "MarqueeToothed", + ebcdicArabic = "EbcdicArabic", /** - * Represents a border with sharks teeth design. + * EBCDIC Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sharksTeeth = "SharksTeeth", + ebcdicGreek = "EbcdicGreek", /** - * Represents a border with sawtooth design. + * EBCDIC Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtooth = "Sawtooth", + ebcdicHebrew = "EbcdicHebrew", /** - * Represents a border with gray sawtooth design. + * EBCDIC Korean Extended encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtoothGray = "SawtoothGray", + ebcdicKoreanExtended = "EbcdicKoreanExtended", /** - * Represents a border with postage stamp design. + * EBCDIC Thai encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - postageStamp = "PostageStamp", + ebcdicThai = "EbcdicThai", /** - * Represents a border with weaving strips design. + * EBCDIC Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingStrips = "WeavingStrips", + ebcdicIcelandic = "EbcdicIcelandic", /** - * Represents a border with zigzag design. + * EBCDIC Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + ebcdicTurkish = "EbcdicTurkish", /** - * Represents a border with cross stitch design. + * EBCDIC Russian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossStitch = "CrossStitch", + ebcdicRussian = "EbcdicRussian", /** - * Represents a border with gems design. + * EBCDIC Serbian-Bulgarian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gems = "Gems", + ebcdicSerbianBulgarian = "EbcdicSerbianBulgarian", /** - * Represents a border with circles and rectangles design. + * EBCDIC Japanese Katakana Extended and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesRectangles = "CirclesRectangles", + ebcdicJapaneseKatakanaExtendedAndJapanese = "EbcdicJapaneseKatakanaExtendedAndJapanese", /** - * Represents a border with corner triangles design. + * EBCDIC US-Canada and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cornerTriangles = "CornerTriangles", + ebcdicUsCanadaAndJapanese = "EbcdicUsCanadaAndJapanese", /** - * Represents a border with insects creatures design. + * EBCDIC Korean Extended and Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesInsects = "CreaturesInsects", + ebcdicKoreanExtendedAndKorean = "EbcdicKoreanExtendedAndKorean", /** - * Represents a border with zigzag stitch design. + * EBCDIC Simplified Chinese Extended and Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZagStitch = "ZigZagStitch", + ebcdicSimplifiedChineseExtendedAndSimplifiedChinese = "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese", /** - * Represents a border with checkered design. + * EBCDIC US-Canada and Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkered = "Checkered", + ebcdicUsCanadaAndTraditionalChinese = "EbcdicUsCanadaAndTraditionalChinese", /** - * Represents a border with black checked bar design. + * EBCDIC Japanese Latin Extended and Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarBlack = "CheckedBarBlack", + ebcdicJapaneseLatinExtendedAndJapanese = "EbcdicJapaneseLatinExtendedAndJapanese", /** - * Represents a border with marquee design. + * OEM United States encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marquee = "Marquee", + oemUnitedStates = "OemUnitedStates", /** - * Represents a border with basic white dots design. + * OEM Greek 437G encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDots = "BasicWhiteDots", + oemGreek437G = "OemGreek437G", /** - * Represents a border with basic wide midline design. + * OEM Baltic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideMidline = "BasicWideMidline", + oemBaltic = "OemBaltic", /** - * Represents a border with basic wide outline design. + * OEM Multilingual Latin I encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideOutline = "BasicWideOutline", + oemMultilingualLatinI = "OemMultilingualLatinI", /** - * Represents a border with basic wide inline design. + * OEM Multilingual Latin II encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideInline = "BasicWideInline", + oemMultilingualLatinIi = "OemMultilingualLatinIi", /** - * Represents a border with basic thin lines design. + * OEM Cyrillic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicThinLines = "BasicThinLines", + oemCyrillic = "OemCyrillic", /** - * Represents a border with basic white dashes design. + * OEM Turkish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDashes = "BasicWhiteDashes", + oemTurkish = "OemTurkish", /** - * Represents a border with basic white squares design. + * OEM Portuguese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteSquares = "BasicWhiteSquares", + oemPortuguese = "OemPortuguese", /** - * Represents a border with basic black squares design. + * OEM Icelandic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackSquares = "BasicBlackSquares", + oemIcelandic = "OemIcelandic", /** - * Represents a border with basic black dashes design. + * OEM Hebrew encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDashes = "BasicBlackDashes", + oemHebrew = "OemHebrew", /** - * Represents a border with basic black dots design. + * OEM Canadian French encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDots = "BasicBlackDots", + oemCanadianFrench = "OemCanadianFrench", /** - * Represents a border with top stars design. + * OEM Arabic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsTop = "StarsTop", + oemArabic = "OemArabic", /** - * Represents a border with certificate banner design. + * OEM Nordic encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - certificateBanner = "CertificateBanner", + oemNordic = "OemNordic", /** - * Represents a border with handmade design (variant 1). + * OEM Cyrillic II encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade1 = "Handmade1", + oemCyrillicIi = "OemCyrillicIi", /** - * Represents a border with handmade design (variant 2). + * OEM Modern Greek encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade2 = "Handmade2", + oemModernGreek = "OemModernGreek", /** - * Represents a border with torn paper design. + * EUC Japanese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaper = "TornPaper", + eucJapanese = "EucJapanese", /** - * Represents a border with black torn paper design. + * EUC Chinese Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaperBlack = "TornPaperBlack", + eucChineseSimplifiedChinese = "EucChineseSimplifiedChinese", /** - * Represents a border with coupon cutout dashes design. + * EUC Korean encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDashes = "CouponCutoutDashes", + eucKorean = "EucKorean", /** - * Represents a border with coupon cutout dots design. + * EUC Taiwanese Traditional Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDots = "CouponCutoutDots", - } - /** - * Specifies the preferred unit of measure to use when measuring the width of an item. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PreferredWidthType { + eucTaiwaneseTraditionalChinese = "EucTaiwaneseTraditionalChinese", /** - * Automatically select the unit of measure to use based on the current selection. + * ISCII Devanagari encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + isciiDevanagari = "IsciiDevanagari", /** - * Measure the current item width using a specified percentage. + * ISCII Bengali encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + isciiBengali = "IsciiBengali", /** - * Measure the current item width using a specified number of points. + * ISCII Tamil encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Represents the reading order of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingOrder { + isciiTamil = "IsciiTamil", /** - * Represents right-to-left reading order. + * ISCII Telugu encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + isciiTelugu = "IsciiTelugu", /** - * Represents left-to-right reading order. + * ISCII Assamese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", - } - /** - * Specifies the way Word adjusts the table when the left indent is changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RulerStyle { + isciiAssamese = "IsciiAssamese", /** - * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. + * ISCII Oriya encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + isciiOriya = "IsciiOriya", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. + * ISCII Kannada encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + isciiKannada = "IsciiKannada", /** - * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * ISCII Malayalam encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + isciiMalayalam = "IsciiMalayalam", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * ISCII Gujarati encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sameWidth = "SameWidth", - } - /** - * Represents the East Asian language to use when breaking lines of text in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLanguageId { + isciiGujarati = "IsciiGujarati", /** - * Represents Traditional Chinese language. + * ISCII Punjabi encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + isciiPunjabi = "IsciiPunjabi", /** - * Represents Japanese language. + * Arabic ASMO encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + arabicAsmo = "ArabicAsmo", /** - * Represents Korean language. + * Arabic Transparent ASMO encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + arabicTransparentAsmo = "ArabicTransparentAsmo", /** - * Represents Simplified Chinese language. + * Korean Johab encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", - } - /** - * Represents the level of line breaking to use for East Asian languages in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLevel { + koreanJohab = "KoreanJohab", /** - * Represents the normal line break level. + * Taiwan CNS encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + taiwanCns = "TaiwanCns", /** - * Represents the strict line break level. + * Taiwan TCA encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - strict = "Strict", + taiwanTca = "TaiwanTca", /** - * Represents the custom line break level. + * Taiwan Eten encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies the character spacing adjustment for a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum JustificationMode { + taiwanEten = "TaiwanEten", /** - * Expands the character spacing + * Taiwan IBM5550 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expand = "Expand", + taiwanIbm5550 = "TaiwanIbm5550", /** - * Compresses the character spacing. + * Taiwan TeleText encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compress = "Compress", + taiwanTeleText = "TaiwanTeleText", /** - * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * Taiwan Wang encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compressKana = "CompressKana", - } - /** - * Specifies the type of template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TemplateType { + taiwanWang = "TaiwanWang", /** - * Represents the normal template type. + * IA5 IRV encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + ia5Irv = "Ia5Irv", /** - * Represents the global template type. + * IA5 German encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - global = "Global", + ia5German = "Ia5German", /** - * Represents the attached template type. + * IA5 Swedish encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attached = "Attached", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LanguageId { + ia5Swedish = "Ia5Swedish", /** - * Afrikaans language. + * IA5 Norwegian encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - afrikaans = "Afrikaans", + ia5Norwegian = "Ia5Norwegian", /** - * Albanian language. + * US ASCII encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - albanian = "Albanian", + usaAscii = "UsaAscii", /** - * Amharic language. + * T61 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - amharic = "Amharic", + t61 = "T61", /** - * Arabic language. + * ISO 6937 Non-Spacing Accent encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + iso6937NonSpacingAccent = "Iso6937NonSpacingAccent", /** - * Arabic Algerian language. + * KOI8-R encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicAlgeria = "ArabicAlgeria", + koi8R = "Koi8R", /** - * Arabic Bahraini language. + * Ext Alpha Lowercase encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicBahrain = "ArabicBahrain", + extAlphaLowercase = "ExtAlphaLowercase", /** - * Arabic Egyptian language. + * KOI8-U encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicEgypt = "ArabicEgypt", + koi8U = "Koi8U", /** - * Arabic Iraqi language. + * Europa3 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicIraq = "ArabicIraq", + europa3 = "Europa3", /** - * Arabic Jordanian language. + * HZ GB Simplified Chinese encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicJordan = "ArabicJordan", + hzGbSimplifiedChinese = "HzGbSimplifiedChinese", /** - * Arabic Kuwaiti language. + * Simplified Chinese GB18030 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicKuwait = "ArabicKuwait", + simplifiedChineseGb18030 = "SimplifiedChineseGb18030", /** - * Arabic Lebanese language. + * UTF-7 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLebanon = "ArabicLebanon", + utf7 = "Utf7", /** - * Arabic Libyan language. + * UTF-8 encoding. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLibya = "ArabicLibya", + utf8 = "Utf8", + } + /** + * Specifies the compatibility mode that Word uses when opening the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CompatibilityMode { /** - * Arabic Moroccan language. + * Word 2003 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicMorocco = "ArabicMorocco", + word2003 = "Word2003", /** - * Arabic Omani language. + * Word 2007 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicOman = "ArabicOman", + word2007 = "Word2007", /** - * Arabic Qatari language. + * Word 2010 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicQatar = "ArabicQatar", + word2010 = "Word2010", /** - * Arabic Syrian language. + * Word 2013 compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicSyria = "ArabicSyria", + word2013 = "Word2013", /** - * Arabic Tunisian language. + * Current Word version compatibility mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicTunisia = "ArabicTunisia", + current = "Current", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** - * Arabic United Arab Emirates language. + * Represents that the style is a character style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - arabicUAE = "ArabicUAE", + character = "Character", /** - * Arabic Yemeni language. + * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - arabicYemen = "ArabicYemen", + list = "List", /** - * Armenian language. + * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - armenian = "Armenian", + paragraph = "Paragraph", /** - * Assamese language. + * Represents that the style is a table style. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - assamese = "Assamese", + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { /** - * Azerbaijani Cyrillic language. + * Represents outline level 1. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - azeriCyrillic = "AzeriCyrillic", + outlineLevel1 = "OutlineLevel1", /** - * Azerbaijani Latin language. + * Represents outline level 2. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - azeriLatin = "AzeriLatin", + outlineLevel2 = "OutlineLevel2", /** - * Basque (Basque). + * Represents outline level 3. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - basque = "Basque", + outlineLevel3 = "OutlineLevel3", /** - * Belgian Dutch language. + * Represents outline level 4. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belgianDutch = "BelgianDutch", + outlineLevel4 = "OutlineLevel4", /** - * Belgian French language. + * Represents outline level 5. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belgianFrench = "BelgianFrench", + outlineLevel5 = "OutlineLevel5", /** - * Bengali language. + * Represents outline level 6. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - bengali = "Bengali", + outlineLevel6 = "OutlineLevel6", /** - * Bulgarian language. + * Represents outline level 7. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - bulgarian = "Bulgarian", + outlineLevel7 = "OutlineLevel7", /** - * Burmese language. + * Represents outline level 8. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - burmese = "Burmese", + outlineLevel8 = "OutlineLevel8", /** - * Belarusian language. + * Represents outline level 9. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - belarusian = "Belarusian", + outlineLevel9 = "OutlineLevel9", /** - * Catalan language. + * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - catalan = "Catalan", + outlineLevelBodyText = "OutlineLevelBodyText", + } + /** + * Specifies the close behavior for `Document.close`. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum CloseBehavior { /** - * Cherokee language. + * Saves the changes before closing the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - cherokee = "Cherokee", + save = "Save", /** - * Chinese Hong Kong SAR language. + * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - chineseHongKongSAR = "ChineseHongKongSAR", + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { /** - * Chinese Macao SAR language. + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - chineseMacaoSAR = "ChineseMacaoSAR", + save = "Save", /** - * Chinese Singapore language. + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - chineseSingapore = "ChineseSingapore", + prompt = "Prompt", + } + /** + * Represents the type of Field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { /** - * Croatian language. + * Represents that the field type is Add-in. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - croatian = "Croatian", + addin = "Addin", /** - * Czech language. + * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - czech = "Czech", + addressBlock = "AddressBlock", /** - * Danish language. + * Represents that the field type is Advance. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - danish = "Danish", + advance = "Advance", /** - * Divehi language. + * Represents that the field type is Ask. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - divehi = "Divehi", + ask = "Ask", /** - * Dutch language. + * Represents that the field type is Author. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - dutch = "Dutch", + author = "Author", /** - * Edo language. + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - edo = "Edo", + autoText = "AutoText", /** - * Australian English language. + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishAUS = "EnglishAUS", + autoTextList = "AutoTextList", /** - * Belize English language. + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishBelize = "EnglishBelize", + barCode = "BarCode", /** - * Canadian English language. + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishCanadian = "EnglishCanadian", + bibliography = "Bibliography", /** - * Caribbean English language. + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishCaribbean = "EnglishCaribbean", + bidiOutline = "BidiOutline", /** - * Indonesian English language. + * Represents that the field type is Citation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishIndonesia = "EnglishIndonesia", + citation = "Citation", /** - * Irish English language. + * Represents that the field type is Comments. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishIreland = "EnglishIreland", + comments = "Comments", /** - * Jamaican English language. + * Represents that the field type is Compare. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishJamaica = "EnglishJamaica", + compare = "Compare", /** - * New Zealand English language. + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishNewZealand = "EnglishNewZealand", + createDate = "CreateDate", /** - * Filipino English language. + * Represents that the field type is Data. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishPhilippines = "EnglishPhilippines", + data = "Data", /** - * South African English language. + * Represents that the field type is Database. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishSouthAfrica = "EnglishSouthAfrica", + database = "Database", /** - * Tobago Trinidad English language. + * Represents that the field type is Date. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishTrinidadTobago = "EnglishTrinidadTobago", + date = "Date", /** - * United Kingdom English language. + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishUK = "EnglishUK", + displayBarcode = "DisplayBarcode", /** - * United States English language. + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishUS = "EnglishUS", + docProperty = "DocProperty", /** - * Zimbabwe English language. + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - englishZimbabwe = "EnglishZimbabwe", + docVariable = "DocVariable", /** - * Estonian language. + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - estonian = "Estonian", + editTime = "EditTime", /** - * Faeroese language. + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - faeroese = "Faeroese", + embedded = "Embedded", /** - * Filipino language. + * Represents that the field type is Equation. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - filipino = "Filipino", + eq = "EQ", /** - * Finnish language. + * Represents that the field type is Expression. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - finnish = "Finnish", + expression = "Expression", /** - * French language. + * Represents that the field type is FileName. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - french = "French", + fileName = "FileName", /** - * French Cameroon language. + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCameroon = "FrenchCameroon", + fileSize = "FileSize", /** - * French Canadian language. + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCanadian = "FrenchCanadian", + fillIn = "FillIn", /** - * French (Congo (DRC)) language. + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCongoDRC = "FrenchCongoDRC", + formCheckbox = "FormCheckbox", /** - * French Cote d'Ivoire language. + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchCotedIvoire = "FrenchCotedIvoire", + formDropdown = "FormDropdown", /** - * French Haiti language. + * Represents that the field type is FormText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchHaiti = "FrenchHaiti", + formText = "FormText", /** - * French Luxembourg language. + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchLuxembourg = "FrenchLuxembourg", + gotoButton = "GotoButton", /** - * French Mali language. + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMali = "FrenchMali", + greetingLine = "GreetingLine", /** - * French Monaco language. + * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMonaco = "FrenchMonaco", + hyperlink = "Hyperlink", /** - * French Morocco language. + * Represents that the field type is If. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchMorocco = "FrenchMorocco", + if = "If", /** - * French Reunion language. + * Represents that the field type is Import. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchReunion = "FrenchReunion", + import = "Import", /** - * French Senegal language. + * Represents that the field type is Include. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchSenegal = "FrenchSenegal", + include = "Include", /** - * French West Indies language. + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frenchWestIndies = "FrenchWestIndies", + includePicture = "IncludePicture", /** - * Frisian Netherlands language. + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - frisianNetherlands = "FrisianNetherlands", + includeText = "IncludeText", /** - * Fulfulde language. + * Represents that the field type is Index. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - fulfulde = "Fulfulde", + index = "Index", /** - * Irish (Irish) language. + * Represents that the field type is Information. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gaelicIreland = "GaelicIreland", + info = "Info", /** - * Scottish Gaelic language. + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gaelicScotland = "GaelicScotland", + keywords = "Keywords", /** - * Galician language. + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - galician = "Galician", + lastSavedBy = "LastSavedBy", /** - * Georgian language. + * Represents that the field type is Link. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - georgian = "Georgian", + link = "Link", /** - * German language. + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - german = "German", + listNum = "ListNum", /** - * German Austrian language. + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanAustria = "GermanAustria", + macroButton = "MacroButton", /** - * German Liechtenstein language. + * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanLiechtenstein = "GermanLiechtenstein", + mergeBarcode = "MergeBarcode", /** - * German Luxembourg language. + * Represents that the field type is MergeField. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - germanLuxembourg = "GermanLuxembourg", + mergeField = "MergeField", /** - * Greek language. + * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - greek = "Greek", + mergeRec = "MergeRec", /** - * Guarani language. + * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - guarani = "Guarani", + mergeSeq = "MergeSeq", /** - * Gujarati language. + * Represents that the field type is Next. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - gujarati = "Gujarati", + next = "Next", /** - * Hausa language. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hausa = "Hausa", + nextIf = "NextIf", /** - * Hawaiian language. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hawaiian = "Hawaiian", + noteRef = "NoteRef", /** - * Hebrew language. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hebrew = "Hebrew", + numChars = "NumChars", /** - * Hindi language. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hindi = "Hindi", + numPages = "NumPages", /** - * Hungarian language. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - hungarian = "Hungarian", + numWords = "NumWords", /** - * Ibibio language. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - ibibio = "Ibibio", + ocx = "OCX", /** - * Icelandic language. + * Represents that the field type is Page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - icelandic = "Icelandic", + page = "Page", /** - * Igbo language. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - igbo = "Igbo", + pageRef = "PageRef", /** - * Indonesian language. + * Represents that the field type is Print. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - indonesian = "Indonesian", + print = "Print", /** - * Inuktitut language. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - inuktitut = "Inuktitut", + printDate = "PrintDate", /** - * Italian language. + * Represents that the field type is Private. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - italian = "Italian", + private = "Private", /** - * Japanese language. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - japanese = "Japanese", + quote = "Quote", /** - * Kannada language. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kannada = "Kannada", + rd = "RD", /** - * Kanuri language. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kanuri = "Kanuri", + ref = "Ref", /** - * Kashmiri language. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kashmiri = "Kashmiri", + revNum = "RevNum", /** - * Kazakh language. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kazakh = "Kazakh", + saveDate = "SaveDate", /** - * Khmer language. + * Represents that the field type is Section. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - khmer = "Khmer", + section = "Section", /** - * Kirghiz language. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kirghiz = "Kirghiz", + sectionPages = "SectionPages", /** - * Konkani language. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - konkani = "Konkani", + seq = "Seq", /** - * Korean language. + * Represents that the field type is Set. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - korean = "Korean", + set = "Set", /** - * Kyrgyz language. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - kyrgyz = "Kyrgyz", + shape = "Shape", /** - * No specified language. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageNone = "LanguageNone", + skipIf = "SkipIf", /** - * Lao language. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lao = "Lao", + styleRef = "StyleRef", /** - * Latin language. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - latin = "Latin", + subject = "Subject", /** - * Latvian language. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - latvian = "Latvian", + subscriber = "Subscriber", /** - * Lithuanian language. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lithuanian = "Lithuanian", + symbol = "Symbol", /** - * Macedonian language. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - macedonianFYROM = "MacedonianFYROM", + ta = "TA", /** - * Malayalam language. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malayalam = "Malayalam", + tc = "TC", /** - * Malay Brunei Darussalam language. + * Represents that the field type is Template. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + template = "Template", /** - * Malaysian language. + * Represents that the field type is Time. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - malaysian = "Malaysian", + time = "Time", /** - * Maltese language. + * Represents that the field type is Title. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - maltese = "Maltese", + title = "Title", /** - * Manipuri language. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - manipuri = "Manipuri", + toa = "TOA", /** - * Marathi language. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - marathi = "Marathi", + toc = "TOC", /** - * Mexican Spanish language. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - mexicanSpanish = "MexicanSpanish", + userAddress = "UserAddress", /** - * Mongolian language. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - mongolian = "Mongolian", + userInitials = "UserInitials", /** - * Nepali language. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nepali = "Nepali", + userName = "UserName", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - noProofing = "NoProofing", + xe = "XE", /** - * Norwegian Bokmol language. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - norwegianBokmol = "NorwegianBokmol", + empty = "Empty", /** - * Norwegian Nynorsk language. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - norwegianNynorsk = "NorwegianNynorsk", + others = "Others", /** - * Odia (Oriya) language. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - oriya = "Oriya", + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * Oromo language. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - oromo = "Oromo", + none = "None", /** - * Pashto language. + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pashto = "Pashto", + hot = "Hot", /** - * Persian language. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - persian = "Persian", + warm = "Warm", /** - * Polish language. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - polish = "Polish", + cold = "Cold", + } + /** + * Represents the character inserted after the list item mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Portuguese language. + * A tab is inserted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - portuguese = "Portuguese", + trailingTab = "TrailingTab", /** - * Portuguese (Brazil) language. + * A space is inserted. Default. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - portugueseBrazil = "PortugueseBrazil", + trailingSpace = "TrailingSpace", /** - * Punjabi language. + * No character is inserted. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - punjabi = "Punjabi", + trailingNone = "TrailingNone", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ListBuiltInNumberStyle { /** - * Rhaeto Romanic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - rhaetoRomanic = "RhaetoRomanic", + none = "None", /** - * Romanian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - romanian = "Romanian", + arabic = "Arabic", /** - * Romanian Moldova language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - romanianMoldova = "RomanianMoldova", + upperRoman = "UpperRoman", /** - * Russian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - russian = "Russian", + lowerRoman = "LowerRoman", /** - * Russian Moldova language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - russianMoldova = "RussianMoldova", + upperLetter = "UpperLetter", /** - * Sami Lappish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - samiLappish = "SamiLappish", + lowerLetter = "LowerLetter", /** - * Sanskrit language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sanskrit = "Sanskrit", + ordinal = "Ordinal", /** - * Serbian Cyrillic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - serbianCyrillic = "SerbianCyrillic", + cardinalText = "CardinalText", /** - * Serbian Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - serbianLatin = "SerbianLatin", + ordinalText = "OrdinalText", /** - * Sesotho language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sesotho = "Sesotho", + kanji = "Kanji", /** - * Simplified Chinese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - simplifiedChinese = "SimplifiedChinese", + kanjiDigit = "KanjiDigit", /** - * Sindhi language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sindhi = "Sindhi", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Sindhi (Pakistan) language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sindhiPakistan = "SindhiPakistan", + irohaHalfWidth = "IrohaHalfWidth", /** - * Sinhalese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sinhalese = "Sinhalese", + arabicFullWidth = "ArabicFullWidth", /** - * Slovakian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - slovak = "Slovak", + kanjiTraditional = "KanjiTraditional", /** - * Slovenian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - slovenian = "Slovenian", + kanjiTraditional2 = "KanjiTraditional2", /** - * Somali language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - somali = "Somali", + numberInCircle = "NumberInCircle", /** - * Sorbian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sorbian = "Sorbian", + aiueo = "Aiueo", /** - * Spanish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanish = "Spanish", + iroha = "Iroha", /** - * Spanish Argentina language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishArgentina = "SpanishArgentina", + arabicLZ = "ArabicLZ", /** - * Spanish Bolivian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishBolivia = "SpanishBolivia", + bullet = "Bullet", /** - * Spanish Chilean language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishChile = "SpanishChile", + ganada = "Ganada", /** - * Spanish Colombian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishColombia = "SpanishColombia", + chosung = "Chosung", /** - * Spanish Costa Rican language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishCostaRica = "SpanishCostaRica", + gbnum1 = "GBNum1", /** - * Spanish Dominican Republic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + gbnum2 = "GBNum2", /** - * Spanish Ecuadorian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishEcuador = "SpanishEcuador", + gbnum3 = "GBNum3", /** - * Spanish El Salvadorian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishElSalvador = "SpanishElSalvador", + gbnum4 = "GBNum4", /** - * Spanish Guatemala language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishGuatemala = "SpanishGuatemala", + zodiac1 = "Zodiac1", /** - * Spanish Honduran language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishHonduras = "SpanishHonduras", + zodiac2 = "Zodiac2", /** - * Spanish Modern Sort language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishModernSort = "SpanishModernSort", + zodiac3 = "Zodiac3", /** - * Spanish Nicaraguan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishNicaragua = "SpanishNicaragua", + tradChinNum1 = "TradChinNum1", /** - * Spanish Panamanian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishPanama = "SpanishPanama", - /** - * Spanish Paraguayan language. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spanishParaguay = "SpanishParaguay", - /** - * Spanish Peruvian language. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spanishPeru = "SpanishPeru", - /** - * Spanish Puerto Rican language. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spanishPuertoRico = "SpanishPuertoRico", - /** - * Spanish Uruguayan language. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - spanishUruguay = "SpanishUruguay", + tradChinNum2 = "TradChinNum2", /** - * Spanish Venezuelan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spanishVenezuela = "SpanishVenezuela", + tradChinNum3 = "TradChinNum3", /** - * Sutu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sutu = "Sutu", + tradChinNum4 = "TradChinNum4", /** - * Swahili language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swahili = "Swahili", + simpChinNum1 = "SimpChinNum1", /** - * Swedish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swedish = "Swedish", + simpChinNum2 = "SimpChinNum2", /** - * Swedish Finnish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swedishFinland = "SwedishFinland", + simpChinNum3 = "SimpChinNum3", /** - * Swiss French language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissFrench = "SwissFrench", + simpChinNum4 = "SimpChinNum4", /** - * Swiss German language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissGerman = "SwissGerman", + hanjaRead = "HanjaRead", /** - * Swiss Italian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - swissItalian = "SwissItalian", + hanjaReadDigit = "HanjaReadDigit", /** - * Syriac language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - syriac = "Syriac", + hangul = "Hangul", /** - * Tajik language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tajik = "Tajik", + hanja = "Hanja", /** - * Tamazight language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamazight = "Tamazight", + hebrew1 = "Hebrew1", /** - * Tamazight Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamazightLatin = "TamazightLatin", + arabic1 = "Arabic1", /** - * Tamil language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tamil = "Tamil", + hebrew2 = "Hebrew2", /** - * Tatar language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tatar = "Tatar", + arabic2 = "Arabic2", /** - * Telugu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - telugu = "Telugu", + hindiLetter1 = "HindiLetter1", /** - * Thai language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - thai = "Thai", + hindiLetter2 = "HindiLetter2", /** - * Tibetan language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tibetan = "Tibetan", + hindiArabic = "HindiArabic", /** - * Tigrigna Eritrea language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tigrignaEritrea = "TigrignaEritrea", + hindiCardinalText = "HindiCardinalText", /** - * Tigrigna Ethiopic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tigrignaEthiopic = "TigrignaEthiopic", + thaiLetter = "ThaiLetter", /** - * Traditional Chinese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - traditionalChinese = "TraditionalChinese", + thaiArabic = "ThaiArabic", /** - * Tsonga language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tsonga = "Tsonga", + thaiCardinalText = "ThaiCardinalText", /** - * Tswana language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tswana = "Tswana", + vietCardinalText = "VietCardinalText", /** - * Turkish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - turkish = "Turkish", + lowercaseRussian = "LowercaseRussian", /** - * Turkmen language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - turkmen = "Turkmen", + uppercaseRussian = "UppercaseRussian", /** - * Ukrainian language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ukrainian = "Ukrainian", + lowercaseGreek = "LowercaseGreek", /** - * Urdu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - urdu = "Urdu", + uppercaseGreek = "UppercaseGreek", /** - * Uzbek Cyrillic language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - uzbekCyrillic = "UzbekCyrillic", + arabicLZ2 = "ArabicLZ2", /** - * Uzbek Latin language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - uzbekLatin = "UzbekLatin", + arabicLZ3 = "ArabicLZ3", /** - * Venda language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - venda = "Venda", + arabicLZ4 = "ArabicLZ4", /** - * Vietnamese language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - vietnamese = "Vietnamese", + lowercaseTurkish = "LowercaseTurkish", /** - * Welsh language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - welsh = "Welsh", + uppercaseTurkish = "UppercaseTurkish", /** - * Xhosa language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - xhosa = "Xhosa", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Yi language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yi = "Yi", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Yiddish language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yiddish = "Yiddish", + pictureBullet = "PictureBullet", /** - * Yoruba language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - yoruba = "Yoruba", + legal = "Legal", /** - * Zulu language. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - zulu = "Zulu", + legalLZ = "LegalLZ", } /** - * Specifies how a building block is inserted into a document. + * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - enum DocPartInsertType { + enum ShadingTextureType { /** - * Inserts the content of the building block. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - content = "Content", + darkDiagonalDown = "DarkDiagonalDown", /** - * Inserts the building block as a paragraph. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - paragraph = "Paragraph", + darkDiagonalUp = "DarkDiagonalUp", /** - * Inserts the building block as a page. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - page = "Page", - } - /** - * Specifies the type of building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BuildingBlockType { + darkGrid = "DarkGrid", /** - * Represents Quick Parts building block type. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - quickParts = "QuickParts", + darkHorizontal = "DarkHorizontal", /** - * Represents Cover Page building block type. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - coverPage = "CoverPage", + darkTrellis = "DarkTrellis", /** - * Represents Equations building block type. + * Represents dark vertical texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - equations = "Equations", + darkVertical = "DarkVertical", /** - * Represents Footers building block type. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - footers = "Footers", + lightDiagonalDown = "LightDiagonalDown", /** - * Represents Headers building block type. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - headers = "Headers", + lightDiagonalUp = "LightDiagonalUp", /** - * Represents Page Number building block type. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumber = "PageNumber", + lightGrid = "LightGrid", /** - * Represents Tables building block type. + * Represents light horizontal texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tables = "Tables", + lightHorizontal = "LightHorizontal", /** - * Represents Watermarks building block type. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - watermarks = "Watermarks", + lightTrellis = "LightTrellis", /** - * Represents AutoText building block type. + * Represents light vertical texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - autoText = "AutoText", + lightVertical = "LightVertical", /** - * Represents Text Box building block type. + * Represents that there's no texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - textBox = "TextBox", + none = "None", /** - * Represents Page Number Top building block type. + * Represents 10 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberTop = "PageNumberTop", + percent10 = "Percent10", /** - * Represents Page Number Bottom building block type. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberBottom = "PageNumberBottom", + percent12Pt5 = "Percent12Pt5", /** - * Represents Page Number Page building block type. + * Represents 15 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - pageNumberPage = "PageNumberPage", + percent15 = "Percent15", /** - * Represents Table of Contents building block type. + * Represents 20 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - tableOfContents = "TableOfContents", + percent20 = "Percent20", /** - * Represents Custom Quick Parts building block type. + * Represents 25 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customQuickParts = "CustomQuickParts", + percent25 = "Percent25", /** - * Represents Custom Cover Page building block type. + * Represents 30 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customCoverPage = "CustomCoverPage", + percent30 = "Percent30", /** - * Represents Custom Equations building block type. + * Represents 35 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customEquations = "CustomEquations", + percent35 = "Percent35", /** - * Represents Custom Footers building block type. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customFooters = "CustomFooters", + percent37Pt5 = "Percent37Pt5", /** - * Represents Custom Headers building block type. + * Represents 40 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customHeaders = "CustomHeaders", + percent40 = "Percent40", /** - * Represents Custom Page Number building block type. + * Represents 45 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumber = "CustomPageNumber", + percent45 = "Percent45", /** - * Represents Custom Tables building block type. + * Represents 5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTables = "CustomTables", + percent5 = "Percent5", /** - * Represents Custom Watermarks building block type. + * Represents 50 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customWatermarks = "CustomWatermarks", + percent50 = "Percent50", /** - * Represents Custom AutoText building block type. + * Represents 55 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customAutoText = "CustomAutoText", + percent55 = "Percent55", /** - * Represents Custom Text Box building block type. + * Represents 60 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTextBox = "CustomTextBox", + percent60 = "Percent60", /** - * Represents Custom Page Number Top building block type. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberTop = "CustomPageNumberTop", + percent62Pt5 = "Percent62Pt5", /** - * Represents Custom Page Number Bottom building block type. + * Represents 65 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberBottom = "CustomPageNumberBottom", + percent65 = "Percent65", /** - * Represents Custom Page Number Page building block type. + * Represents 70 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customPageNumberPage = "CustomPageNumberPage", + percent70 = "Percent70", /** - * Represents Custom Table of Contents building block type. + * Represents 75 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customTableOfContents = "CustomTableOfContents", + percent75 = "Percent75", /** - * Represents Custom building block type 1. + * Represents 80 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom1 = "Custom1", + percent80 = "Percent80", /** - * Represents Custom building block type 2. + * Represents 85 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom2 = "Custom2", + percent85 = "Percent85", /** - * Represents Custom building block type 3. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom3 = "Custom3", + percent87Pt5 = "Percent87Pt5", /** - * Represents Custom building block type 4. + * Represents 90 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom4 = "Custom4", + percent90 = "Percent90", /** - * Represents Custom building block type 5. + * Represents 95 percent texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - custom5 = "Custom5", - /** - * Represents Bibliography building block type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bibliography = "Bibliography", + percent95 = "Percent95", /** - * Represents Custom Bibliography building block type. + * Represents solid texture. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - customBibliography = "CustomBibliography", + solid = "Solid", } /** - * Represents the type of a {@link Word.CustomXmlValidationError}. + * Specifies the target document for displaying document comparison differences. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - enum CustomXmlValidationErrorType { + enum CompareTarget { /** - * Represents a validation error generated by the schema. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - schemaGenerated = "schemaGenerated", + compareTargetCurrent = "CompareTargetCurrent", /** - * Represents a validation error that is automatically cleared. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - automaticallyCleared = "automaticallyCleared", + compareTargetSelected = "CompareTargetSelected", /** - * Represents a validation error that is manually created. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - manual = "manual", + compareTargetNew = "CompareTargetNew", } /** - * Represents the type of a {@link Word.CustomXmlNode}. + * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - enum CustomXmlNodeType { + enum ImportedStylesConflictBehavior { /** - * Represents an XML element node. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - element = "element", + ignore = "Ignore", /** - * Represents an XML attribute node. + * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - attribute = "attribute", + overwrite = "Overwrite", /** - * Represents an XML text node. + * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - text = "text", + createNew = "CreateNew", + } + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeType { /** - * Represents an XML CDATA section node. + * Unsupported shape type. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cData = "cData", + unsupported = "Unsupported", /** - * Represents an XML processing instruction node. + * Text box shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - processingInstruction = "processingInstruction", + textBox = "TextBox", /** - * Represents an XML comment node. + * Geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - comment = "comment", + geometricShape = "GeometricShape", /** - * Represents an XML document node. + * Group shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - document = "document", + group = "Group", + /** + * Picture shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + picture = "Picture", + /** + * Canvas shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + canvas = "Canvas", } /** - * Specifies the type of link. + * 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 + * [Api set: WordApiDesktop 1.2] */ - enum LinkType { - /** - * OLE object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - ole = "Ole", + enum RelativeHorizontalPosition { /** - * Picture. + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - picture = "Picture", + margin = "Margin", /** - * Text. + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text = "Text", + page = "Page", /** - * Reference library. + * Relative to column. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - reference = "Reference", + column = "Column", /** - * Include file. + * Relative to character. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - include = "Include", + character = "Character", /** - * Import file. + * Relative to left margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - import = "Import", + leftMargin = "LeftMargin", /** - * Dynamic Data Exchange. + * Relative to right margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dde = "Dde", + rightMargin = "RightMargin", /** - * Automatic DDE. + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ddeAuto = "DdeAuto", + insideMargin = "InsideMargin", /** - * Microsoft Excel chart. + * Relative to outside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chart = "Chart", + outsideMargin = "OutsideMargin", } /** - * Specifies the action associated with the verb that the OLE object should perform. + * 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 + * [Api set: WordApiDesktop 1.2] */ - enum OleVerb { + enum RelativeVerticalPosition { /** - * Performs the verb that is invoked when the user double-clicks the object. + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - primary = "Primary", + margin = "Margin", /** - * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - show = "Show", + page = "Page", /** - * Opens the object in a separate window. + * Relative to paragraph. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - open = "Open", + paragraph = "Paragraph", /** - * Removes the object's user interface from view. + * Relative to line. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hide = "Hide", + line = "Line", /** - * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * Relative to top margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - uiActivate = "UiActivate", + topMargin = "TopMargin", /** - * Runs the object and installs its window, but doesn't install any user-interface tools. + * Relative to bottom margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - inPlaceActivate = "InPlaceActivate", + bottomMargin = "BottomMargin", /** - * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - discardUndoState = "DiscardUndoState", + insideMargin = "InsideMargin", + /** + * Relative to outside margin. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + outsideMargin = "OutsideMargin", } /** - * Represents the list formatting characteristics of a range. + * Represents what the horizontal or vertical size 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 + * [Api set: WordApiDesktop 1.2] */ - class ListFormat 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; + enum RelativeSize { /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Relative to margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly list: Word.List; + margin = "Margin", /** - * Gets the list template associated with the `ListFormat` object. - * + * Relative to page. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listTemplate: Word.ListTemplate; + page = "Page", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Relative to top margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly isSingleList: boolean; + topMargin = "TopMargin", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * Relative to bottom margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly isSingleListTemplate: boolean; + bottomMargin = "BottomMargin", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * Relative to inside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listLevelNumber: number; + insideMargin = "InsideMargin", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * Relative to outside margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listString: string; + outsideMargin = "OutsideMargin", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum GeometricShapeType { /** - * Gets the type of the list for the `ListFormat` object. - * + * Line inverse geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + lineInverse = "LineInverse", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * Triangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly listValue: number; + triangle = "Triangle", /** - * 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. + * Right triangle geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListFormat): void; + rightTriangle = "RightTriangle", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * [Api set: WordApiDesktop 1.2] */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + rectangle = "Rectangle", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Diamond geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. + * [Api set: WordApiDesktop 1.2] */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + diamond = "Diamond", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * Parallelogram geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param listTemplate The list template to apply. - * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. + * [Api set: WordApiDesktop 1.2] */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + parallelogram = "Parallelogram", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Trapezoid geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + trapezoid = "Trapezoid", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Non-isosceles trapezoid geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Pentagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + pentagon = "Pentagon", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Hexagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. + * [Api set: WordApiDesktop 1.2] */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + hexagon = "Hexagon", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * Heptagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param listTemplate The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. + * [Api set: WordApiDesktop 1.2] */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + heptagon = "Heptagon", /** - * Converts numbers in the list to plain text. - * + * Octagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.2] */ - convertNumbersToText(numberType: Word.NumberType): void; + octagon = "Octagon", /** - * Converts numbers in the list to plain text. - * + * Decagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType Optional. The type of number to convert. + * [Api set: WordApiDesktop 1.2] */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + decagon = "Decagon", /** - * Counts the numbered items in the list. - * + * Dodecagon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. - * @returns The number of items. + * [Api set: WordApiDesktop 1.2] */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + dodecagon = "Dodecagon", /** - * Indents the list by one level. - * + * Star 4-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listIndent(): void; + star4 = "Star4", /** - * Outdents the list by one level. - * + * Star 5-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listOutdent(): void; + star5 = "Star5", /** - * Removes numbering from the list. - * + * Star 6-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.2] */ - removeNumbers(numberType: Word.NumberType): void; + star6 = "Star6", /** - * Removes numbering from the list. - * + * Star 7-point geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param numberType Optional. The type of number to remove. + * [Api set: WordApiDesktop 1.2] */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + star7 = "Star7", /** - * 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. + * Star 8-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + star8 = "Star8", /** - * 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. + * Star 10-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ListFormat; + star10 = "Star10", /** - * 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. + * Star 12-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ListFormat; + star12 = "Star12", /** - * 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. + * Star 16-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ListFormat; + star16 = "Star16", /** - * 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. + * Star 24-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ListFormat; + star24 = "Star24", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Star 32-point geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListFormatCountNumberedItemsOptions { + star32 = "Star32", /** - * If provided, specifies the level to count. The default value is 1. - * + * Round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - level?: number; + roundRectangle = "RoundRectangle", /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. - * + * Round one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; - } - /** - * Represents options for applying a list template to a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListTemplateApplyOptions { + round1Rectangle = "Round1Rectangle", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Round two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - applyLevel?: number; + round2SameRectangle = "Round2SameRectangle", /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. - * + * Round two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Snip round rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - continuePreviousList?: boolean; + snipRoundRectangle = "SnipRoundRectangle", /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. - * + * Snip one rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; - } - /** - * Represents the fill formatting for a shape or text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class FillFormat 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; + snip1Rectangle = "Snip1Rectangle", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly backgroundColor: Word.ColorFormat; + snip2SameRectangle = "Snip2SameRectangle", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * Plaque geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gradientAngle: number; + plaque = "Plaque", /** - * Gets the gradient color type. - * + * Ellipse geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + ellipse = "Ellipse", /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. - * + * Teardrop geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientDegree: number; + teardrop = "Teardrop", /** - * Returns the gradient style for the fill. - * + * Home plate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + homePlate = "HomePlate", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * Chevron geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly gradientVariant: number; + chevron = "Chevron", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Pie wedge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + pieWedge = "PieWedge", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * Pie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + pie = "Pie", /** - * Returns the preset gradient type for the fill. - * + * Block arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + blockArc = "BlockArc", /** - * Gets the preset texture. - * + * Donut geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + donut = "Donut", /** - * Specifies whether the fill rotates with the shape. - * + * No smoking geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotateWithObject: boolean; + noSmoking = "NoSmoking", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * Right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + rightArrow = "RightArrow", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * Left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureHorizontalScale: number; + leftArrow = "LeftArrow", /** - * Returns the name of the custom texture file for the fill. - * + * Up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly textureName: string; + upArrow = "UpArrow", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * Down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureOffsetX: number; + downArrow = "DownArrow", /** - * Specifies the vertical offset of the texture. - * + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureOffsetY: number; + stripedRightArrow = "StripedRightArrow", /** - * Specifies whether the texture is tiled. - * + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureTile: boolean; + notchedRightArrow = "NotchedRightArrow", /** - * Returns the texture type for the fill. - * + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + bentUpArrow = "BentUpArrow", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textureVerticalScale: number; + leftRightArrow = "LeftRightArrow", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + upDownArrow = "UpDownArrow", /** - * Gets the fill format type. - * + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + leftUpArrow = "LeftUpArrow", /** - * 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. + * Left-right-up arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.FillFormat): void; + leftRightUpArrow = "LeftRightUpArrow", /** - * Sets the fill to a one-color gradient. - * + * Quad arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.2] */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + quadArrow = "QuadArrow", /** - * Sets the fill to a one-color gradient. - * + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). + * [Api set: WordApiDesktop 1.2] */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + leftArrowCallout = "LeftArrowCallout", /** - * Sets the fill to a pattern. - * + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPatterned(pattern: Word.PatternType): void; + rightArrowCallout = "RightArrowCallout", /** - * Sets the fill to a pattern. - * + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + upArrowCallout = "UpArrowCallout", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + downArrowCallout = "DownArrowCallout", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Sets the fill to a preset texture. - * + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + upDownArrowCallout = "UpDownArrowCallout", /** - * Sets the fill to a preset texture. - * + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + quadArrowCallout = "QuadArrowCallout", /** - * Sets the fill to a two-color gradient. - * + * Bent arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + bentArrow = "BentArrow", /** - * Sets the fill to a two-color gradient. - * + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + uturnArrow = "UturnArrow", /** - * Sets the fill to a uniform color. - * + * Circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - solid(): void; + circularArrow = "CircularArrow", /** - * 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. + * Left circular arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; + leftCircularArrow = "LeftCircularArrow", /** - * 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. + * Left-right circular arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.FillFormat; + leftRightCircularArrow = "LeftRightCircularArrow", /** - * 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. + * Curved right arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.FillFormat; + curvedRightArrow = "CurvedRightArrow", /** - * 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. + * Curved left arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.FillFormat; + curvedLeftArrow = "CurvedLeftArrow", /** - * 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. + * Curved up arrow geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.FillFormat; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FillFormatData; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class GlowFormat 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; + curvedUpArrow = "CurvedUpArrow", /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly color: Word.ColorFormat; + curvedDownArrow = "CurvedDownArrow", /** - * Specifies the length of the radius for a glow effect. - * + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - radius: number; + swooshArrow = "SwooshArrow", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Cube geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + cube = "Cube", /** - * 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. + * Can geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GlowFormat): void; + can = "Can", /** - * 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. + * Lightning bolt geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + lightningBolt = "LightningBolt", /** - * 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. + * Heart geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.GlowFormat; + heart = "Heart", /** - * 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. + * Sun geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + sun = "Sun", /** - * 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. + * Moon geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.GlowFormat; + moon = "Moon", /** - * 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. + * Smiley face geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.GlowFormat; + smileyFace = "SmileyFace", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Irregular seal 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.GlowFormatData; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class LineFormat 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; + irregularSeal1 = "IrregularSeal1", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly backgroundColor: Word.ColorFormat; + irregularSeal2 = "IrregularSeal2", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * Folded corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + foldedCorner = "FoldedCorner", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * Bevel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + bevel = "Bevel", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * Frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + frame = "Frame", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * Half frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + halfFrame = "HalfFrame", /** - * Specifies the dash style for the line. - * + * Corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + corner = "Corner", /** - * Specifies the length of the arrowhead at the end of the line. - * + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + diagonalStripe = "DiagonalStripe", /** - * Specifies the style of the arrowhead at the end of the line. - * + * Chord geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + chord = "Chord", /** - * Specifies the width of the arrowhead at the end of the line. - * + * Arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + arc = "Arc", /** - * Specifies if to draw lines inside a shape. - * + * Left bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insetPen: boolean; + leftBracket = "LeftBracket", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Right bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + rightBracket = "RightBracket", /** - * Specifies the pattern applied to the line. - * + * Left brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + leftBrace = "LeftBrace", /** - * Specifies the line format style. - * + * Right brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + rightBrace = "RightBrace", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Bracket pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + bracketPair = "BracketPair", /** - * Specifies the thickness of the line in points. - * + * Brace pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weight: number; + bracePair = "BracePair", /** - * 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. + * Callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineFormat): void; + callout1 = "Callout1", /** - * 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. + * Callout 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + callout2 = "Callout2", /** - * 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. + * Callout 3 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.LineFormat; + callout3 = "Callout3", /** - * 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. + * Accent callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + accentCallout1 = "AccentCallout1", /** - * 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. + * Accent callout 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.LineFormat; + accentCallout2 = "AccentCallout2", /** - * 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. + * Accent callout 3 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.LineFormat; + accentCallout3 = "AccentCallout3", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Border callout 1 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.LineFormatData; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ReflectionFormat 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; + borderCallout1 = "BorderCallout1", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - blur: number; + borderCallout2 = "BorderCallout2", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offset: number; + borderCallout3 = "BorderCallout3", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - size: number; + accentBorderCallout1 = "AccentBorderCallout1", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + accentBorderCallout2 = "AccentBorderCallout2", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + accentBorderCallout3 = "AccentBorderCallout3", /** - * 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. + * Wedge rectangle callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ReflectionFormat): void; + wedgeRectCallout = "WedgeRectCallout", /** - * 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. + * Wedge rounded rectangle callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + wedgeRRectCallout = "WedgeRRectCallout", /** - * 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. + * Wedge ellipse callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * 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. + * Cloud callout geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ReflectionFormat; + cloudCallout = "CloudCallout", /** - * 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. + * Cloud geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ReflectionFormat; + cloud = "Cloud", /** - * 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. + * Ribbon geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ReflectionFormat; + ribbon = "Ribbon", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Ribbon 2 geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ReflectionFormatData; - } - /** - * Represents the color formatting of a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ColorFormat 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; + ribbon2 = "Ribbon2", /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - brightness: number; + ellipseRibbon = "EllipseRibbon", /** - * Specifies the theme color for a color format. - * + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + ellipseRibbon2 = "EllipseRibbon2", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rgb: string; + leftRightRibbon = "LeftRightRibbon", /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tintAndShade: number; + verticalScroll = "VerticalScroll", /** - * Returns the shape color type. - * + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly type: Word.ColorType | "rgb" | "scheme"; + horizontalScroll = "HorizontalScroll", /** - * 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. + * Wave geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ColorFormat): void; + wave = "Wave", /** - * 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. + * Double wave geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + doubleWave = "DoubleWave", /** - * 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. + * Plus geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ColorFormat; + plus = "Plus", /** - * 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. + * Flow chart process geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ColorFormat; + flowChartProcess = "FlowChartProcess", /** - * 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. + * Flow chart decision geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ColorFormat; + flowChartDecision = "FlowChartDecision", /** - * 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. + * Flow chart input-output geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ColorFormat; + flowChartInputOutput = "FlowChartInputOutput", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Flow chart predefined process geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ColorFormatData; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ShadowFormat 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; + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly foregroundColor: Word.ColorFormat; + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Flow chart document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - blur: number; + flowChartDocument = "FlowChartDocument", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + flowChartMultidocument = "FlowChartMultidocument", /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. - * + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - obscured: boolean; + flowChartTerminator = "FlowChartTerminator", /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offsetX: number; + flowChartPreparation = "FlowChartPreparation", /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. - * + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - offsetY: number; + flowChartManualInput = "FlowChartManualInput", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotateWithShape: boolean; + flowChartManualOperation = "FlowChartManualOperation", /** - * Specifies the width of the shadow. - * + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - size: number; + flowChartConnector = "FlowChartConnector", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - transparency: number; + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Specifies the shape shadow type. - * + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - /** - * 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. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadowFormat): void; + flowChartSummingJunction = "FlowChartSummingJunction", /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Flow chart OR geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementOffsetX(increment: number): void; + flowChartOr = "FlowChartOr", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - incrementOffsetY(increment: number): 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.ShadowFormatLoadOptions): Word.ShadowFormat; - /** - * 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.ShadowFormat; - /** - * 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. + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadowFormat; + flowChartCollate = "FlowChartCollate", /** - * 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. + * Flow chart sort geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ShadowFormat; + flowChartSort = "FlowChartSort", /** - * 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. + * Flow chart extract geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ShadowFormat; + flowChartExtract = "FlowChartExtract", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Flow chart merge geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ShadowFormatData; - } - /** - * Represents a shape's three-dimensional formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ThreeDimensionalFormat 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; + flowChartMerge = "FlowChartMerge", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Flow chart offline storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly contourColor: Word.ColorFormat; + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Flow chart online storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly extrusionColor: Word.ColorFormat; + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Specifies the depth of the bottom bevel. - * + * Flow chart magnetic tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomDepth: number; + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Specifies the inset size for the bottom bevel. - * + * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomInset: number; + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Specifies the depth of the top bevel. - * + * Flow chart display geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopDepth: number; + flowChartDisplay = "FlowChartDisplay", /** - * Specifies the inset size for the top bevel. - * + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopInset: number; + flowChartDelay = "FlowChartDelay", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Specifies the width of the contour of a shape. - * + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - contourWidth: number; + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Specifies the depth of the shape's extrusion. - * + * Action button blank geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - depth: number; + actionButtonBlank = "ActionButtonBlank", /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * + * Action button home geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + actionButtonHome = "ActionButtonHome", /** - * Specifies the amount of perspective for a shape. - * + * Action button help geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fieldOfView: number; + actionButtonHelp = "ActionButtonHelp", /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * + * Action button information geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isPerspective: boolean; + actionButtonInformation = "ActionButtonInformation", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Action button forward next geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible: boolean; + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Specifies the angle of the lighting. - * + * Action button back previous geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightAngle: number; + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Action button end geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + actionButtonEnd = "ActionButtonEnd", /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * Action button beginning geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + actionButtonBeginning = "ActionButtonBeginning", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Action button return geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + actionButtonReturn = "ActionButtonReturn", /** - * Specifies the position of the light source relative to the extrusion. - * + * Action button document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + actionButtonDocument = "ActionButtonDocument", /** - * Specifies the intensity of the extrusion lighting. - * + * Action button sound geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + actionButtonSound = "ActionButtonSound", /** - * Specifies the extrusion surface material. - * + * Action button movie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + actionButtonMovie = "ActionButtonMovie", /** - * Returns the preset extrusion format. - * + * Gear 6 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + gear6 = "Gear6", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Gear 9 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - projectText: boolean; + gear9 = "Gear9", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Funnel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationX: number; + funnel = "Funnel", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Math plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationY: number; + mathPlus = "MathPlus", /** - * Specifies the z-axis rotation of the camera. - * + * Math minus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rotationZ: number; + mathMinus = "MathMinus", /** - * Specifies the position on the z-axis for the shape. - * + * Math multiply geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - z: number; + mathMultiply = "MathMultiply", /** - * 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. + * Math divide geometric shape. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ThreeDimensionalFormat): void; + mathDivide = "MathDivide", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Math equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationHorizontal(increment: number): void; + mathEqual = "MathEqual", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Math not equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationVertical(increment: number): void; + mathNotEqual = "MathNotEqual", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Corner tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationX(increment: number): void; + cornerTabs = "CornerTabs", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Square tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationY(increment: number): void; + squareTabs = "SquareTabs", /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. - * + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - incrementRotationZ(increment: number): void; + plaqueTabs = "PlaqueTabs", /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. - * + * Chart X geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - resetRotation(): void; + chartX = "ChartX", /** - * Sets the direction of the extrusion's sweep path. - * + * Chart star geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param presetExtrusionDirection The preset direction. + * [Api set: WordApiDesktop 1.2] */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + chartStar = "ChartStar", /** - * Sets the direction of the extrusion's sweep path. - * + * Chart plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param presetExtrusionDirection The preset direction. + * [Api set: WordApiDesktop 1.2] */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + chartPlus = "ChartPlus", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { /** - * Sets the camera preset for the shape. - The preset camera type. - * + * No fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + noFill = "NoFill", /** - * Sets the camera preset for the shape. - The preset camera type. - * + * Solid fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + solid = "Solid", /** - * Sets the preset extrusion format. - The preset format. - * + * Gradient fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + gradient = "Gradient", /** - * Sets the preset extrusion format. - The preset format. - * + * Pattern fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + pattern = "Pattern", /** - * 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. + * Picture fill. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + picture = "Picture", /** - * 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. + * Texture fill. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + texture = "Texture", /** - * 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. + * Mixed fill. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ThreeDimensionalFormat; + mixed = "Mixed", + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextVerticalAlignment { /** - * 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. + * Anchor the text at the top of the bounding rectangle. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.ThreeDimensionalFormat; + top = "Top", /** - * 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. + * Anchor the text at the middle of the bounding rectangle. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.ThreeDimensionalFormat; + middle = "Middle", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Anchor the text at the bottom of the bounding rectangle. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.ThreeDimensionalFormatData; + bottom = "Bottom", } /** - * Specifies the length of the arrowhead at the end of a line. + * Specifies the orientation for the text frame in a shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum ArrowheadLength { + enum ShapeTextOrientation { /** - * Represents a mixed arrowhead length. + * No orientation, such as in a new geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + none = "None", /** - * Represents a short arrowhead length. + * Horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - short = "Short", + horizontal = "Horizontal", /** - * Represents a medium arrowhead length. + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - medium = "Medium", + eastAsianVertical = "EastAsianVertical", /** - * Represents a long arrowhead length. + * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - long = "Long", - } - /** - * Specifies the style of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadStyle { + vertical270 = "Vertical270", /** - * Represents a mixed arrowhead style. + * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + vertical = "Vertical", /** - * Represents no arrowhead. + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - none = "None", + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", /** - * Represents a triangle arrowhead style. + * A combination of automatic orientation is used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangle = "Triangle", + mixed = "Mixed", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeAutoSize { /** - * Represents an open arrowhead style. + * No autosizing. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - open = "Open", + none = "None", /** - * Represents a stealth arrowhead style. + * The text is adjusted to fit the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stealth = "Stealth", + textToFitShape = "TextToFitShape", /** - * Represents a diamond arrowhead style. + * The shape is adjusted to fit the text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - diamond = "Diamond", + shapeToFitText = "ShapeToFitText", /** - * Represents an oval arrowhead style. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - oval = "Oval", + mixed = "Mixed", } /** - * Specifies the width of the arrowhead at the end of a line. + * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum ArrowheadWidth { + enum ShapeTextWrapType { /** - * Represents a mixed arrowhead width. + * Places the shape in line with text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", + inline = "Inline", /** - * Represents a narrow arrowhead width. + * Wraps text squarely around the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - narrow = "Narrow", + square = "Square", /** - * Represents a medium arrowhead width. + * Wraps text close to the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - medium = "Medium", + tight = "Tight", /** - * Represents a wide arrowhead width. + * Wraps text around and through the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - wide = "Wide", + through = "Through", + /** + * Places text above and below the shape. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topBottom = "TopBottom", + /** + * Places shape behind text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + behind = "Behind", + /** + * Places shape in front of text. + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + front = "Front", } /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - enum BevelType { - /** - * Represents a mixed bevel type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "mixed", + enum ShapeTextWrapSide { /** - * Represents no bevel. + * Has no wrap side property, such as those for inline shapes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - none = "none", + none = "None", /** - * Represents a relaxed inset bevel. + * Both left and right sides of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - relaxedInset = "relaxedInset", + both = "Both", /** - * Represents a circle bevel. + * Left side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - circle = "circle", + left = "Left", /** - * Represents a slope bevel. + * Right side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - slope = "slope", + right = "Right", /** - * Represents a cross bevel. + * Side of the shape that's farther from the respective page margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cross = "cross", + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { /** - * Represents an angle bevel. + * Scale from current size of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - angle = "angle", + currentSize = "CurrentSize", /** - * Represents a soft round bevel. + * Scale from original size of the shape. It only works for pictures. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - softRound = "softRound", + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { /** - * Represents a convex bevel. + * Scale from the top left corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - convex = "convex", + scaleFromTopLeft = "ScaleFromTopLeft", /** - * Represents a cool slant bevel. + * Scale from the center of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - coolSlant = "coolSlant", + scaleFromMiddle = "ScaleFromMiddle", /** - * Represents a divot bevel. + * Scale from the bottom right corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - divot = "divot", + scaleFromBottomRight = "ScaleFromBottomRight", + } + /** + * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FrameSizeRule { /** - * Represents a riblet bevel. + * The height or width is set according to the height or width of the item in the frame. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - riblet = "riblet", + auto = "Auto", /** - * Represents a hard edge bevel. + * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hardEdge = "hardEdge", + atLeast = "AtLeast", /** - * Represents an art deco bevel. + * The height or width is set to an exact value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artDeco = "artDeco", + exact = "Exact", } /** - * Represents color index values in a Word document. + * Specifies the border style for an object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ColorIndex { + enum BorderLineStyle { /** - * Automatically determines the color. + * No line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + none = "None", /** - * Represents the color black. + * Single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - black = "Black", + single = "Single", /** - * Represents the color blue. + * Dotted line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blue = "Blue", + dot = "Dot", /** - * Represents the color turquoise. + * Dashed line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turquoise = "Turquoise", + dashSmallGap = "DashSmallGap", /** - * Represents a bright green color. + * Dashed line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightGreen = "BrightGreen", + dashLargeGap = "DashLargeGap", /** - * Represents the color pink. + * Dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pink = "Pink", + dashDot = "DashDot", /** - * Represents the color red. + * Dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - red = "Red", + dashDotDot = "DashDotDot", /** - * Represents the color yellow. + * Double line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yellow = "Yellow", + double = "Double", /** - * Represents the color white. + * Triple line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - white = "White", + triple = "Triple", /** - * Represents a dark blue color. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkBlue = "DarkBlue", + thinThickSmallGap = "ThinThickSmallGap", /** - * Represents the color teal. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - teal = "Teal", + thickThinSmallGap = "ThickThinSmallGap", /** - * Represents the color green. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - green = "Green", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Represents the color violet. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - violet = "Violet", + thinThickMedGap = "ThinThickMedGap", /** - * Represents a dark red color. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkRed = "DarkRed", + thickThinMedGap = "ThickThinMedGap", /** - * Represents a dark yellow color. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkYellow = "DarkYellow", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Represents a gray color with 50% intensity. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray50 = "Gray50", + thinThickLargeGap = "ThinThickLargeGap", /** - * Represents a gray color with 25% intensity. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gray25 = "Gray25", + thickThinLargeGap = "ThickThinLargeGap", /** - * Represents a classic red color. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicRed = "ClassicRed", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Represents a classic blue color. + * Single wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicBlue = "ClassicBlue", + singleWavy = "SingleWavy", /** - * Represents a color determined by the author. + * Double wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - byAuthor = "ByAuthor", - } - /** - * Specifies the color type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorType { + doubleWavy = "DoubleWavy", /** - * Represents an RGB color type. + * Dash-dot stroked line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb = "rgb", + dashDotStroked = "DashDotStroked", /** - * Represents a scheme color type. + * Embossed 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scheme = "scheme", - } - /** - * Specifies whether the formatting from the previous list can be continued. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Continue { + emboss3D = "Emboss3D", /** - * Formatting cannot continue from the previous list. + * Engraved 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disabled = "Disabled", + engrave3D = "Engrave3D", /** - * Formatting can continue from the previous list. + * Outset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + outset = "Outset", /** - * Numbering can be restarted. + * Inset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reset = "Reset", + inset = "Inset", } /** - * Specifies the default list behavior for a list. + * Specifies the width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DefaultListBehavior { + enum LineWidth { /** - * Use formatting compatible with Microsoft Word 97. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word97 = "Word97", + pt025 = "Pt025", /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word2000 = "Word2000", + pt050 = "Pt050", /** - * Use formatting compatible with Microsoft Word 2002. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word2002 = "Word2002", - } - /** - * Specifies the type of emphasis mark to use for a character or designated character string. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum EmphasisMark { + pt075 = "Pt075", /** - * No emphasis mark. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + pt100 = "Pt100", /** - * Emphasis mark over a solid circle. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overSolidCircle = "OverSolidCircle", + pt150 = "Pt150", /** - * Emphasis mark over a comma. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overComma = "OverComma", + pt225 = "Pt225", /** - * Emphasis mark over a white circle. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overWhiteCircle = "OverWhiteCircle", + pt300 = "Pt300", /** - * Emphasis mark under a solid circle. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underSolidCircle = "UnderSolidCircle", + pt450 = "Pt450", + /** + * Represents a line width of 6.00 points. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pt600 = "Pt600", } /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Specifies the graphical page border setting of a page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ExtrusionColorType { + enum PageBorderArt { /** - * Represents a mixed extrusion color type. + * Represents a border with apple design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + apples = "Apples", /** - * Represents an automatic extrusion color based on the shape's fill. + * Represents a border with maple muffin design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "automatic", + mapleMuffins = "MapleMuffins", /** - * Represents a custom extrusion color independent of the shape's fill. + * Represents a border with cake slice design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "custom", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FillType { + cakeSlice = "CakeSlice", /** - * Represents a mixed fill type. + * Represents a border with candy corn design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + candyCorn = "CandyCorn", /** - * Represents a solid fill type. + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + iceCreamCones = "IceCreamCones", /** - * Represents a patterned fill type. + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - patterned = "Patterned", + champagneBottle = "ChampagneBottle", /** - * Represents a gradient fill type. + * Represents a border with party glass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + partyGlass = "PartyGlass", /** - * Represents a textured fill type. + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textured = "Textured", + christmasTree = "ChristmasTree", /** - * Represents a background fill type. + * Represents a border with trees design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background = "Background", + trees = "Trees", /** - * Represents a picture fill type. + * Represents a border with palm trees in color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", - } - /** - * Specifies the type of gradient used in a shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientColorType { + palmsColor = "PalmsColor", /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + balloons3Colors = "Balloons3Colors", /** - * Gradient with a single color and varying transparency or brightness. + * Represents a border with hot air balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oneColor = "OneColor", + balloonsHotAir = "BalloonsHotAir", /** - * Gradient that blends two distinct colors. + * Represents a border with party favor design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoColors = "TwoColors", + partyFavor = "PartyFavor", /** - * Gradient that uses a predefined set of colors. + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetColors = "PresetColors", + confettiStreamers = "ConfettiStreamers", /** - * Gradient that includes more than two colors, often customized. + * Represents a border with hearts design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiColor = "MultiColor", - } - /** - * Specifies the style for a gradient fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientStyle { + hearts = "Hearts", /** - * Represents a mixed gradient style. + * Represents a border with heart balloon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + heartBalloon = "HeartBalloon", /** - * Represents a horizontal gradient style. + * Represents a border with 3D stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + stars3D = "Stars3D", /** - * Represents a vertical gradient style. + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + starsShadowed = "StarsShadowed", /** - * Represents a diagonal-up gradient style. + * Represents a border with stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalUp = "DiagonalUp", + stars = "Stars", /** - * Represents a diagonal-down gradient style. + * Represents a border with sun design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalDown = "DiagonalDown", + sun = "Sun", /** - * Represents a gradient style from the corner. + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromCorner = "FromCorner", + earth2 = "Earth2", /** - * Represents a gradient style from the title. + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromTitle = "FromTitle", + earth1 = "Earth1", /** - * Represents a gradient style from the center. + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fromCenter = "FromCenter", - } - /** - * Specifies the type of ligature applied to a font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Ligature { + peopleHats = "PeopleHats", /** - * No ligatures applied. + * Represents a border with sombrero design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + sombrero = "Sombrero", /** - * Standard ligatures applied. + * Represents a border with pencils design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + pencils = "Pencils", /** - * Contextual ligatures applied. + * Represents a border with packages design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextual = "Contextual", + packages = "Packages", /** - * Standard and contextual ligatures applied. + * Represents a border with clocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextual = "StandardContextual", + clocks = "Clocks", /** - * Historical ligatures applied. + * Represents a border with firecrackers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historical = "Historical", + firecrackers = "Firecrackers", /** - * Standard and historical ligatures applied. + * Represents a border with rings design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistorical = "StandardHistorical", + rings = "Rings", /** - * Contextual and historical ligatures applied. + * Represents a border with map pins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistorical = "ContextualHistorical", + mapPins = "MapPins", /** - * Standard, contextual, and historical ligatures applied. + * Represents a border with confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualHistorical = "StandardContextualHistorical", + confetti = "Confetti", /** - * Discretional ligatures applied. + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - discretional = "Discretional", + creaturesButterfly = "CreaturesButterfly", /** - * Standard and discretional ligatures applied. + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardDiscretional = "StandardDiscretional", + creaturesLadyBug = "CreaturesLadyBug", /** - * Contextual and discretional ligatures applied. + * Represents a border with fish creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualDiscretional = "ContextualDiscretional", + creaturesFish = "CreaturesFish", /** - * Standard, contextual, and discretional ligatures applied. + * Represents a border with birds in flight design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualDiscretional = "StandardContextualDiscretional", + birdsFlight = "BirdsFlight", /** - * Historical and discretional ligatures applied. + * Represents a border with scared cat design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historicalDiscretional = "HistoricalDiscretional", + scaredCat = "ScaredCat", /** - * Standard, historical, and discretional ligatures applied. + * Represents a border with bats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + bats = "Bats", /** - * Contextual, historical, and discretional ligatures applied. + * Represents a border with roses flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + flowersRoses = "FlowersRoses", /** - * All ligatures applied. + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", - } - /** - * Indicates the effects lighting for an object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LightRigType { + flowersRedRose = "FlowersRedRose", /** - * Represents a mixed light rig type. + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + poinsettias = "Poinsettias", /** - * Represents legacy flat light rig type 1. + * Represents a border with holly design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat1 = "LegacyFlat1", + holly = "Holly", /** - * Represents legacy flat light rig type 2. + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat2 = "LegacyFlat2", + flowersTiny = "FlowersTiny", /** - * Represents legacy flat light rig type 3. + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat3 = "LegacyFlat3", + flowersPansy = "FlowersPansy", /** - * Represents legacy flat light rig type 4. + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat4 = "LegacyFlat4", + flowersModern2 = "FlowersModern2", /** - * Represents legacy normal light rig type 1. + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal1 = "LegacyNormal1", + flowersModern1 = "FlowersModern1", /** - * Represents legacy normal light rig type 2. + * Represents a border with white flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal2 = "LegacyNormal2", + whiteFlowers = "WhiteFlowers", /** - * Represents legacy normal light rig type 3. + * Represents a border with vine design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal3 = "LegacyNormal3", + vine = "Vine", /** - * Represents legacy normal light rig type 4. + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal4 = "LegacyNormal4", + flowersDaisies = "FlowersDaisies", /** - * Represents legacy harsh light rig type 1. + * Represents a border with block print flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh1 = "LegacyHarsh1", + flowersBlockPrint = "FlowersBlockPrint", /** - * Represents legacy harsh light rig type 2. + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh2 = "LegacyHarsh2", + decoArchColor = "DecoArchColor", /** - * Represents legacy harsh light rig type 3. + * Represents a border with fans design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh3 = "LegacyHarsh3", + fans = "Fans", /** - * Represents legacy harsh light rig type 4. + * Represents a border with film design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh4 = "LegacyHarsh4", + film = "Film", /** - * Represents a three-point light rig type. + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threePoint = "ThreePoint", + lightning1 = "Lightning1", /** - * Represents a balanced light rig type. + * Represents a border with compass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balanced = "Balanced", + compass = "Compass", /** - * Represents a soft light rig type. + * Represents a border with double D design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - soft = "Soft", + doubleD = "DoubleD", /** - * Represents a harsh light rig type. + * Represents a border with classical wave design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - harsh = "Harsh", + classicalWave = "ClassicalWave", /** - * Represents a flood light rig type. + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flood = "Flood", + shadowedSquares = "ShadowedSquares", /** - * Represents a contrasting light rig type. + * Represents a border with twisted lines design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contrasting = "Contrasting", + twistedLines1 = "TwistedLines1", /** - * Represents a morning light rig type. + * Represents a border with waveline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - morning = "Morning", + waveline = "Waveline", /** - * Represents a sunrise light rig type. + * Represents a border with quadrants design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunrise = "Sunrise", + quadrants = "Quadrants", /** - * Represents a sunset light rig type. + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunset = "Sunset", + checkedBarColor = "CheckedBarColor", /** - * Represents a chilly light rig type. + * Represents a border with swirligig design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chilly = "Chilly", + swirligig = "Swirligig", /** - * Represents a freezing light rig type. + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - freezing = "Freezing", + pushPinNote1 = "PushPinNote1", /** - * Represents a flat light rig type. + * Represents a border with push pin note design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + pushPinNote2 = "PushPinNote2", /** - * Represents a two-point light rig type. + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPoint = "TwoPoint", + pumpkin1 = "Pumpkin1", /** - * Represents a glow light rig type. + * Represents a border with black eggs design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow = "Glow", + eggsBlack = "EggsBlack", /** - * Represents a bright room light rig type. + * Represents a border with cup design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightRoom = "BrightRoom", - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineDashStyle { + cup = "Cup", /** - * Represents a mixed dash style. + * Represents a border with gray heart design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + heartGray = "HeartGray", /** - * Represents a solid line style. + * Represents a border with gingerbread man design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + gingerbreadMan = "GingerbreadMan", /** - * Represents a square dot line style. + * Represents a border with baby pacifier design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareDot = "SquareDot", + babyPacifier = "BabyPacifier", /** - * Represents a round dot line style. + * Represents a border with baby rattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - roundDot = "RoundDot", + babyRattle = "BabyRattle", /** - * Represents a dashed line style. + * Represents a border with cabins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + cabins = "Cabins", /** - * Represents a dash-dot line style. + * Represents a border with funky house design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + houseFunky = "HouseFunky", /** - * Represents a dash-dot-dot line style. + * Represents a border with black stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + starsBlack = "StarsBlack", /** - * Represents a long dash line style. + * Represents a border with snowflakes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDash = "LongDash", + snowflakes = "Snowflakes", /** - * Represents a long dash-dot line style. + * Represents a border with fancy snowflake design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDot = "LongDashDot", + snowflakeFancy = "SnowflakeFancy", /** - * Represents a long dash-dot-dot line style. + * Represents a border with skyrocket design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDotDot = "LongDashDotDot", + skyrocket = "Skyrocket", /** - * Represents a system dash line style. + * Represents a border with Seattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDash = "SysDash", + seattle = "Seattle", /** - * Represents a system dot line style. + * Represents a border with music notes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDot = "SysDot", + musicNotes = "MusicNotes", /** - * Represents a system dash-dot line style. + * Represents a border with black palms design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDashDot = "SysDashDot", - } - /** - * Specifies the style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineFormatStyle { + palmsBlack = "PalmsBlack", /** - * Represents a mixed line style. + * Represents a border with maple leaf design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + mapleLeaf = "MapleLeaf", /** - * Represents a single line style. + * Represents a border with paper clips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + paperClips = "PaperClips", /** - * Represents a thin-thin line style. + * Represents a border with shorebird tracks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThin = "ThinThin", + shorebirdTracks = "ShorebirdTracks", /** - * Represents a thin-thick line style. + * Represents a border with people design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThick = "ThinThick", + people = "People", /** - * Represents a thick-thin line style. + * Represents a border with people waving design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThin = "ThickThin", + peopleWaving = "PeopleWaving", /** - * Represents a thick line between two thin lines style. + * Represents a border with eclipsing squares design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickBetweenThin = "ThickBetweenThin", - } - /** - * Specifies the portion of a list to which to apply a list template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListApplyTo { + eclipsingSquares2 = "EclipsingSquares2", /** - * Applies the list template to the entire list. + * Represents a border with hypnotic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wholeList = "WholeList", + hypnotic = "Hypnotic", /** - * Applies the list template from the cursor insertion point to the end of the list. + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thisPointForward = "ThisPointForward", + diamondsGray = "DiamondsGray", /** - * Applies the list template to the selection. + * Represents a border with deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListType { + decoArch = "DecoArch", /** - * List with no bullets, numbering, or outlining. + * Represents a border with deco blocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNoNumbering = "ListNoNumbering", + decoBlocks = "DecoBlocks", /** - * ListNum fields that can be used in the body of a paragraph. + * Represents a border with circles and lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listListNumOnly = "ListListNumOnly", + circlesLines = "CirclesLines", /** - * Bulleted list. + * Represents a border with papyrus design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listBullet = "ListBullet", + papyrus = "Papyrus", /** - * Simple numeric list. + * Represents a border with woodwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listSimpleNumbering = "ListSimpleNumbering", + woodwork = "Woodwork", /** - * Outlined list. + * Represents a border with weaving braid design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutlineNumbering = "ListOutlineNumbering", + weavingBraid = "WeavingBraid", /** - * Mixed numeric list. + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listMixedNumbering = "ListMixedNumbering", + weavingRibbon = "WeavingRibbon", /** - * Picture bulleted list. + * Represents a border with weaving angles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listPictureBullet = "ListPictureBullet", - } - /** - * Specifies the number form setting for an OpenType font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberForm { + weavingAngles = "WeavingAngles", /** - * Default number form setting. + * Represents a border with arched scallops design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + archedScallops = "ArchedScallops", /** - * Lining number form setting. + * Represents a border with safari design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lining = "Lining", + safari = "Safari", /** - * Old-style number form setting. + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oldStyle = "OldStyle", - } - /** - * Specifies the number spacing setting for an OpenType font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberSpacing { + celticKnotwork = "CelticKnotwork", /** - * Default number spacing setting. + * Represents a border with crazy maze design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + crazyMaze = "CrazyMaze", /** - * Proportional number spacing setting. + * Represents a border with eclipsing squares design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + eclipsingSquares1 = "EclipsingSquares1", /** - * Tabular number spacing setting. + * Represents a border with birds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabular = "Tabular", - } - /** - * Specifies the type of numbers in a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberType { + birds = "Birds", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Represents a border with teacup and flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + flowersTeacup = "FlowersTeacup", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Represents a border with northwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNum = "ListNum", + northwest = "Northwest", /** - * Default value for all other cases. + * Represents a border with southwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allNumbers = "AllNumbers", - } - /** - * Specifies the fill pattern used in a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PatternType { + southwest = "Southwest", /** - * Represents a mixed pattern type. + * Represents a border with tribal design (variant 6). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + tribal6 = "Tribal6", /** - * Represents a 5 percent fill pattern. + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent5 = "Percent5", + tribal4 = "Tribal4", /** - * Represents a 10 percent fill pattern. + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent10 = "Percent10", + tribal3 = "Tribal3", /** - * Represents a 20 percent fill pattern. + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent20 = "Percent20", + tribal2 = "Tribal2", /** - * Represents a 25 percent fill pattern. + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent25 = "Percent25", + tribal5 = "Tribal5", /** - * Represents a 30 percent fill pattern. + * Represents a border with X illusions design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent30 = "Percent30", + xillusions = "XIllusions", /** - * Represents a 40 percent fill pattern. + * Represents a border with zany triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent40 = "Percent40", + zanyTriangles = "ZanyTriangles", /** - * Represents a 50 percent fill pattern. + * Represents a border with pyramids design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent50 = "Percent50", + pyramids = "Pyramids", /** - * Represents a 60 percent fill pattern. + * Represents a border with pyramids above design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent60 = "Percent60", + pyramidsAbove = "PyramidsAbove", /** - * Represents a 70 percent fill pattern. + * Represents a border with gray confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent70 = "Percent70", + confettiGrays = "ConfettiGrays", /** - * Represents a 75 percent fill pattern. + * Represents a border with outline confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent75 = "Percent75", + confettiOutline = "ConfettiOutline", /** - * Represents an 80 percent fill pattern. + * Represents a border with white confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent80 = "Percent80", + confettiWhite = "ConfettiWhite", /** - * Represents a 90 percent fill pattern. + * Represents a border with mosaic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent90 = "Percent90", + mosaic = "Mosaic", /** - * Represents a dark horizontal fill pattern. + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkHorizontal = "DarkHorizontal", + lightning2 = "Lightning2", /** - * Represents a dark vertical fill pattern. + * Represents a border with heebie jeebies design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkVertical = "DarkVertical", + heebieJeebies = "HeebieJeebies", /** - * Represents a dark downward diagonal fill pattern. + * Represents a border with light bulb design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + lightBulb = "LightBulb", /** - * Represents a dark upward diagonal fill pattern. + * Represents a border with gradient design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + gradient = "Gradient", /** - * Represents a small checkerboard fill pattern. + * Represents a border with triangle party design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCheckerBoard = "SmallCheckerBoard", + triangleParty = "TriangleParty", /** - * Represents a trellis fill pattern. + * Represents a border with twisted lines design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trellis = "Trellis", + twistedLines2 = "TwistedLines2", /** - * Represents a light horizontal fill pattern. + * Represents a border with moons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightHorizontal = "LightHorizontal", + moons = "Moons", /** - * Represents a light vertical fill pattern. + * Represents a border with ovals design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightVertical = "LightVertical", + ovals = "Ovals", /** - * Represents a light downward diagonal fill pattern. + * Represents a border with double diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightDownwardDiagonal = "LightDownwardDiagonal", + doubleDiamonds = "DoubleDiamonds", /** - * Represents a light upward diagonal fill pattern. + * Represents a border with chain link design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightUpwardDiagonal = "LightUpwardDiagonal", + chainLink = "ChainLink", /** - * Represents a small grid fill pattern. + * Represents a border with triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallGrid = "SmallGrid", + triangles = "Triangles", /** - * Represents a dotted diamond fill pattern. + * Represents a border with tribal design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedDiamond = "DottedDiamond", + tribal1 = "Tribal1", /** - * Represents a wide downward diagonal fill pattern. + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideDownwardDiagonal = "WideDownwardDiagonal", + marqueeToothed = "MarqueeToothed", /** - * Represents a wide upward diagonal fill pattern. + * Represents a border with sharks teeth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideUpwardDiagonal = "WideUpwardDiagonal", + sharksTeeth = "SharksTeeth", /** - * Represents a dashed upward diagonal fill pattern. + * Represents a border with sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + sawtooth = "Sawtooth", /** - * Represents a dashed downward diagonal fill pattern. + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + sawtoothGray = "SawtoothGray", /** - * Represents a narrow vertical fill pattern. + * Represents a border with postage stamp design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowVertical = "NarrowVertical", + postageStamp = "PostageStamp", /** - * Represents a narrow horizontal fill pattern. + * Represents a border with weaving strips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowHorizontal = "NarrowHorizontal", + weavingStrips = "WeavingStrips", /** - * Represents a dashed vertical fill pattern. + * Represents a border with zigzag design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedVertical = "DashedVertical", + zigZag = "ZigZag", /** - * Represents a dashed horizontal fill pattern. + * Represents a border with cross stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedHorizontal = "DashedHorizontal", + crossStitch = "CrossStitch", /** - * Represents a large confetti fill pattern. + * Represents a border with gems design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeConfetti = "LargeConfetti", + gems = "Gems", /** - * Represents a large grid fill pattern. + * Represents a border with circles and rectangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeGrid = "LargeGrid", + circlesRectangles = "CirclesRectangles", /** - * Represents a horizontal brick fill pattern. + * Represents a border with corner triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalBrick = "HorizontalBrick", + cornerTriangles = "CornerTriangles", /** - * Represents a large checkerboard fill pattern. + * Represents a border with insects creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeCheckerBoard = "LargeCheckerBoard", + creaturesInsects = "CreaturesInsects", /** - * Represents a small confetti fill pattern. + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallConfetti = "SmallConfetti", + zigZagStitch = "ZigZagStitch", /** - * Represents a zigzag fill pattern. + * Represents a border with checkered design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + checkered = "Checkered", /** - * Represents a solid diamond fill pattern. + * Represents a border with black checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solidDiamond = "SolidDiamond", + checkedBarBlack = "CheckedBarBlack", /** - * Represents a diagonal brick fill pattern. + * Represents a border with marquee design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalBrick = "DiagonalBrick", + marquee = "Marquee", /** - * Represents an outlined diamond fill pattern. + * Represents a border with basic white dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinedDiamond = "OutlinedDiamond", + basicWhiteDots = "BasicWhiteDots", /** - * Represents a plaid fill pattern. + * Represents a border with basic wide midline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plaid = "Plaid", + basicWideMidline = "BasicWideMidline", /** - * Represents a sphere fill pattern. + * Represents a border with basic wide outline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sphere = "Sphere", + basicWideOutline = "BasicWideOutline", /** - * Represents a weave fill pattern. + * Represents a border with basic wide inline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weave = "Weave", + basicWideInline = "BasicWideInline", /** - * Represents a dotted grid fill pattern. + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedGrid = "DottedGrid", + basicThinLines = "BasicThinLines", /** - * Represents a divot fill pattern. + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "Divot", + basicWhiteDashes = "BasicWhiteDashes", /** - * Represents a shingle fill pattern. + * Represents a border with basic white squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shingle = "Shingle", + basicWhiteSquares = "BasicWhiteSquares", /** - * Represents a wave fill pattern. + * Represents a border with basic black squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wave = "Wave", + basicBlackSquares = "BasicBlackSquares", /** - * Represents a horizontal fill pattern. + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + basicBlackDashes = "BasicBlackDashes", /** - * Represents a vertical fill pattern. + * Represents a border with basic black dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + basicBlackDots = "BasicBlackDots", /** - * Represents a cross fill pattern. + * Represents a border with top stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "Cross", + starsTop = "StarsTop", /** - * Represents a downward diagonal fill pattern. + * Represents a border with certificate banner design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downwardDiagonal = "DownwardDiagonal", + certificateBanner = "CertificateBanner", /** - * Represents an upward diagonal fill pattern. + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upwardDiagonal = "UpwardDiagonal", + handmade1 = "Handmade1", /** - * Represents a diagonal cross fill pattern. + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalCross = "DiagonalCross", - } - /** - * Indicates the effects camera type used by the specified object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetCamera { + handmade2 = "Handmade2", /** - * Represents a mixed camera type. + * Represents a border with torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + tornPaper = "TornPaper", /** - * Represents a legacy oblique top-left camera type. + * Represents a border with black torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + tornPaperBlack = "TornPaperBlack", /** - * Represents a legacy oblique top camera type. + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTop = "LegacyObliqueTop", + couponCutoutDashes = "CouponCutoutDashes", /** - * Represents a legacy oblique top-right camera type. + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + couponCutoutDots = "CouponCutoutDots", + } + /** + * Specifies the preferred unit of measure to use when measuring the width of an item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PreferredWidthType { /** - * Represents a legacy oblique left camera type. + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueLeft = "LegacyObliqueLeft", + auto = "Auto", /** - * Represents a legacy oblique front camera type. + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueFront = "LegacyObliqueFront", + percent = "Percent", /** - * Represents a legacy oblique right camera type. + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueRight = "LegacyObliqueRight", + points = "Points", + } + /** + * Represents the reading order of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingOrder { /** - * Represents a legacy oblique bottom-left camera type. + * Represents right-to-left reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + rightToLeft = "RightToLeft", /** - * Represents a legacy oblique bottom camera type. + * Represents left-to-right reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottom = "LegacyObliqueBottom", + leftToRight = "LeftToRight", + } + /** + * Specifies the way Word adjusts the table when the left indent is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RulerStyle { /** - * Represents a legacy oblique bottom-right camera type. + * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + none = "None", /** - * Represents a legacy perspective top-left camera type. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + proportional = "Proportional", /** - * Represents a legacy perspective top camera type. + * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + firstColumn = "FirstColumn", /** - * Represents a legacy perspective top-right camera type. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + sameWidth = "SameWidth", + } + /** + * Represents the East Asian language to use when breaking lines of text in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLanguageId { /** - * Represents a legacy perspective left camera type. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + traditionalChinese = "TraditionalChinese", /** - * Represents a legacy perspective front camera type. + * Represents Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + japanese = "Japanese", /** - * Represents a legacy perspective right camera type. + * Represents Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + korean = "Korean", /** - * Represents a legacy perspective bottom-left camera type. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + simplifiedChinese = "SimplifiedChinese", + } + /** + * Represents the level of line breaking to use for East Asian languages in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLevel { /** - * Represents a legacy perspective bottom camera type. + * Represents the normal line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + normal = "Normal", /** - * Represents a legacy perspective bottom-right camera type. + * Represents the strict line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + strict = "Strict", /** - * Represents an orthographic front camera type. + * Represents the custom line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orthographicFront = "OrthographicFront", + custom = "Custom", + } + /** + * Specifies the character spacing adjustment for a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum JustificationMode { /** - * Represents an isometric top-up camera type. + * Expands the character spacing * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopUp = "IsometricTopUp", + expand = "Expand", /** - * Represents an isometric top-down camera type. + * Compresses the character spacing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopDown = "IsometricTopDown", + compress = "Compress", /** - * Represents an isometric bottom-up camera type. + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomUp = "IsometricBottomUp", + compressKana = "CompressKana", + } + /** + * Specifies the type of template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TemplateType { /** - * Represents an isometric bottom-down camera type. + * Represents the normal template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomDown = "IsometricBottomDown", + normal = "Normal", /** - * Represents an isometric left-up camera type. + * Represents the global template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftUp = "IsometricLeftUp", + global = "Global", /** - * Represents an isometric left-down camera type. + * Represents the attached template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftDown = "IsometricLeftDown", + attached = "Attached", + } + /** + * Represents the language ID of a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LanguageId { /** - * Represents an isometric right-up camera type. + * Afrikaans language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightUp = "IsometricRightUp", + afrikaans = "Afrikaans", /** - * Represents an isometric right-down camera type. + * Albanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightDown = "IsometricRightDown", + albanian = "Albanian", /** - * Represents an isometric off-axis 1 left camera type. + * Amharic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + amharic = "Amharic", /** - * Represents an isometric off-axis 1 right camera type. + * Arabic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + arabic = "Arabic", /** - * Represents an isometric off-axis 1 top camera type. + * Arabic Algerian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + arabicAlgeria = "ArabicAlgeria", /** - * Represents an isometric off-axis 2 left camera type. + * Arabic Bahraini language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + arabicBahrain = "ArabicBahrain", /** - * Represents an isometric off-axis 2 right camera type. + * Arabic Egyptian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + arabicEgypt = "ArabicEgypt", /** - * Represents an isometric off-axis 2 top camera type. + * Arabic Iraqi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + arabicIraq = "ArabicIraq", /** - * Represents an isometric off-axis 3 left camera type. + * Arabic Jordanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Left = "IsometricOffAxis3Left", + arabicJordan = "ArabicJordan", /** - * Represents an isometric off-axis 3 right camera type. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + arabicKuwait = "ArabicKuwait", /** - * Represents an isometric off-axis 3 bottom camera type. + * Arabic Lebanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + arabicLebanon = "ArabicLebanon", /** - * Represents an isometric off-axis 4 left camera type. + * Arabic Libyan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + arabicLibya = "ArabicLibya", /** - * Represents an isometric off-axis 4 right camera type. + * Arabic Moroccan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + arabicMorocco = "ArabicMorocco", /** - * Represents an isometric off-axis 4 bottom camera type. + * Arabic Omani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + arabicOman = "ArabicOman", /** - * Represents an oblique top-left camera type. + * Arabic Qatari language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopLeft = "ObliqueTopLeft", + arabicQatar = "ArabicQatar", /** - * Represents an oblique top camera type. + * Arabic Syrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTop = "ObliqueTop", + arabicSyria = "ArabicSyria", /** - * Represents an oblique top-right camera type. + * Arabic Tunisian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopRight = "ObliqueTopRight", + arabicTunisia = "ArabicTunisia", /** - * Represents an oblique left camera type. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueLeft = "ObliqueLeft", + arabicUAE = "ArabicUAE", /** - * Represents an oblique right camera type. + * Arabic Yemeni language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueRight = "ObliqueRight", + arabicYemen = "ArabicYemen", /** - * Represents an oblique bottom-left camera type. + * Armenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomLeft = "ObliqueBottomLeft", + armenian = "Armenian", /** - * Represents an oblique bottom camera type. + * Assamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottom = "ObliqueBottom", + assamese = "Assamese", /** - * Represents an oblique bottom-right camera type. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomRight = "ObliqueBottomRight", + azeriCyrillic = "AzeriCyrillic", /** - * Represents a perspective front camera type. + * Azerbaijani Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveFront = "PerspectiveFront", + azeriLatin = "AzeriLatin", /** - * Represents a perspective left camera type. + * Basque (Basque). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveLeft = "PerspectiveLeft", + basque = "Basque", /** - * Represents a perspective right camera type. + * Belgian Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRight = "PerspectiveRight", + belgianDutch = "BelgianDutch", /** - * Represents a perspective above camera type. + * Belgian French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAbove = "PerspectiveAbove", + belgianFrench = "BelgianFrench", /** - * Represents a perspective below camera type. + * Bengali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveBelow = "PerspectiveBelow", + bengali = "Bengali", /** - * Represents a perspective above-left facing camera type. + * Bulgarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + bulgarian = "Bulgarian", /** - * Represents a perspective above-right facing camera type. + * Burmese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + burmese = "Burmese", /** - * Represents a perspective contrasting-left facing camera type. + * Belarusian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + belarusian = "Belarusian", /** - * Represents a perspective contrasting-right facing camera type. + * Catalan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + catalan = "Catalan", /** - * Represents a perspective heroic-left facing camera type. + * Cherokee language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + cherokee = "Cherokee", /** - * Represents a perspective heroic-right facing camera type. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Represents a perspective heroic-extreme left facing camera type. + * Chinese Macao SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Represents a perspective heroic-extreme right facing camera type. + * Chinese Singapore language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + chineseSingapore = "ChineseSingapore", /** - * Represents a relaxed perspective camera type. + * Croatian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxed = "PerspectiveRelaxed", + croatian = "Croatian", /** - * Represents a moderately relaxed perspective camera type. + * Czech language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", - } - /** - * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetExtrusionDirection { + czech = "Czech", /** - * Represents a mixed extrusion direction. + * Danish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + danish = "Danish", /** - * Represents an extrusion direction to the bottom-right. + * Divehi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + divehi = "Divehi", /** - * Represents an extrusion direction to the bottom. + * Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + dutch = "Dutch", /** - * Represents an extrusion direction to the bottom-left. + * Edo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + edo = "Edo", /** - * Represents an extrusion direction to the right. + * Australian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + englishAUS = "EnglishAUS", /** - * Represents no extrusion direction. + * Belize English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + englishBelize = "EnglishBelize", /** - * Represents an extrusion direction to the left. + * Canadian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + englishCanadian = "EnglishCanadian", /** - * Represents an extrusion direction to the top-right. + * Caribbean English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + englishCaribbean = "EnglishCaribbean", /** - * Represents an extrusion direction to the top. + * Indonesian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + englishIndonesia = "EnglishIndonesia", /** - * Represents an extrusion direction to the top-left. + * Irish English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", - } - /** - * Specifies which predefined gradient to use to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetGradientType { + englishIreland = "EnglishIreland", /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * Jamaican English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + englishJamaica = "EnglishJamaica", /** - * A warm gradient resembling an early sunset. + * New Zealand English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earlySunset = "EarlySunset", + englishNewZealand = "EnglishNewZealand", /** - * A deeper, richer gradient resembling a late sunset. + * Filipino English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lateSunset = "LateSunset", + englishPhilippines = "EnglishPhilippines", /** - * A dark gradient evoking the colors of nightfall. + * South African English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nightfall = "Nightfall", + englishSouthAfrica = "EnglishSouthAfrica", /** - * A light gradient representing the colors of daybreak. + * Tobago Trinidad English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - daybreak = "Daybreak", + englishTrinidadTobago = "EnglishTrinidadTobago", /** - * A gradient that mimics the colors of the horizon. + * United Kingdom English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizon = "Horizon", + englishUK = "EnglishUK", /** - * A warm, sandy gradient inspired by desert tones. + * United States English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - desert = "Desert", + englishUS = "EnglishUS", /** - * A cool gradient reflecting ocean hues. + * Zimbabwe English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ocean = "Ocean", + englishZimbabwe = "EnglishZimbabwe", /** - * A soft, tranquil gradient resembling calm water. + * Estonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calmWater = "CalmWater", + estonian = "Estonian", /** - * A vivid gradient with fiery tones. + * Faeroese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fire = "Fire", + faeroese = "Faeroese", /** - * A muted gradient with fog-like softness. + * Filipino language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fog = "Fog", + filipino = "Filipino", /** - * A natural green gradient inspired by moss. + * Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moss = "Moss", + finnish = "Finnish", /** - * A vibrant gradient with peacock feather colors. + * French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peacock = "Peacock", + french = "French", /** - * A light, golden gradient resembling wheat. + * French Cameroon language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wheat = "Wheat", + frenchCameroon = "FrenchCameroon", /** - * A warm, aged paper-like gradient. + * French Canadian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + frenchCanadian = "FrenchCanadian", /** - * A rich, reddish-brown gradient like mahogany wood. + * French (Congo (DRC)) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mahogany = "Mahogany", + frenchCongoDRC = "FrenchCongoDRC", /** - * A colorful gradient resembling a rainbow. + * French Cote d'Ivoire language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbow = "Rainbow", + frenchCotedIvoire = "FrenchCotedIvoire", /** - * A variation of the rainbow gradient with different color emphasis. + * French Haiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbowII = "RainbowII", + frenchHaiti = "FrenchHaiti", /** - * A shiny, metallic gold gradient. + * French Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gold = "Gold", + frenchLuxembourg = "FrenchLuxembourg", /** - * A variation of the gold gradient with different tones. + * French Mali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - goldII = "GoldII", + frenchMali = "FrenchMali", /** - * A metallic gradient resembling brass. + * French Monaco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brass = "Brass", + frenchMonaco = "FrenchMonaco", /** - * A sleek, reflective chrome gradient. + * French Morocco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chrome = "Chrome", + frenchMorocco = "FrenchMorocco", /** - * A variation of the chrome gradient with alternate highlights. + * French Reunion language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chromeII = "ChromeII", + frenchReunion = "FrenchReunion", /** - * A smooth, metallic silver gradient. + * French Senegal language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - silver = "Silver", + frenchSenegal = "FrenchSenegal", /** - * A deep blue gradient inspired by sapphire. + * French West Indies language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sapphire = "Sapphire", - } - /** - * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingDirection { + frenchWestIndies = "FrenchWestIndies", /** - * Represents a mixed lighting direction. + * Frisian Netherlands language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + frisianNetherlands = "FrisianNetherlands", /** - * Represents lighting from the top-left. + * Fulfulde language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + fulfulde = "Fulfulde", /** - * Represents lighting from the top. + * Irish (Irish) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + gaelicIreland = "GaelicIreland", /** - * Represents lighting from the top-right. + * Scottish Gaelic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + gaelicScotland = "GaelicScotland", /** - * Represents lighting from the left. + * Galician language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + galician = "Galician", /** - * Represents no lighting. + * Georgian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + georgian = "Georgian", /** - * Represents lighting from the right. + * German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + german = "German", /** - * Represents lighting from the bottom-left. + * German Austrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + germanAustria = "GermanAustria", /** - * Represents lighting from the bottom. + * German Liechtenstein language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + germanLiechtenstein = "GermanLiechtenstein", /** - * Represents lighting from the bottom-right. + * German Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", - } - /** - * Specifies the intensity of light used on a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingSoftness { + germanLuxembourg = "GermanLuxembourg", /** - * Represents a mixed lighting softness. + * Greek language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + greek = "Greek", /** - * Represents dim lighting. + * Guarani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dim = "Dim", + guarani = "Guarani", /** - * Represents normal lighting. + * Gujarati language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + gujarati = "Gujarati", /** - * Represents bright lighting. + * Hausa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bright = "Bright", - } - /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetMaterial { + hausa = "Hausa", /** - * Represents a mixed material type. + * Hawaiian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + hawaiian = "Hawaiian", /** - * Represents a matte material. + * Hebrew language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte = "Matte", + hebrew = "Hebrew", /** - * Represents a plastic material. + * Hindi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic = "Plastic", + hindi = "Hindi", /** - * Represents a metal material. + * Hungarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal = "Metal", + hungarian = "Hungarian", /** - * Represents a wireframe material. + * Ibibio language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wireFrame = "WireFrame", + ibibio = "Ibibio", /** - * Represents a second matte material. + * Icelandic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte2 = "Matte2", + icelandic = "Icelandic", /** - * Represents a second plastic material. + * Igbo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic2 = "Plastic2", + igbo = "Igbo", /** - * Represents a second metal material. + * Indonesian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal2 = "Metal2", + indonesian = "Indonesian", /** - * Represents a warm matte material. + * Inuktitut language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warmMatte = "WarmMatte", + inuktitut = "Inuktitut", /** - * Represents a translucent powder material. + * Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - translucentPowder = "TranslucentPowder", + italian = "Italian", /** - * Represents a powder material. + * Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - powder = "Powder", + japanese = "Japanese", /** - * Represents a dark edge material. + * Kannada language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkEdge = "DarkEdge", + kannada = "Kannada", /** - * Represents a soft edge material. + * Kanuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softEdge = "SoftEdge", + kanuri = "Kanuri", /** - * Represents a clear material. + * Kashmiri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clear = "Clear", + kashmiri = "Kashmiri", /** - * Represents a flat material. + * Kazakh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + kazakh = "Kazakh", /** - * Represents a soft metal material. + * Khmer language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softMetal = "SoftMetal", - } - /** - * Specifies texture to be used to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetTexture { + khmer = "Khmer", /** - * Represents a mixed texture type. + * Kirghiz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + kirghiz = "Kirghiz", /** - * Represents a papyrus texture. + * Konkani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + konkani = "Konkani", /** - * Represents a canvas texture. + * Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canvas = "Canvas", + korean = "Korean", /** - * Represents a denim texture. + * Kyrgyz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - denim = "Denim", + kyrgyz = "Kyrgyz", /** - * Represents a woven mat texture. + * No specified language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wovenMat = "WovenMat", + languageNone = "LanguageNone", /** - * Represents a water droplets texture. + * Lao language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waterDroplets = "WaterDroplets", + lao = "Lao", /** - * Represents a paper bag texture. + * Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperBag = "PaperBag", + latin = "Latin", /** - * Represents a fish fossil texture. + * Latvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fishFossil = "FishFossil", + latvian = "Latvian", /** - * Represents a sand texture. + * Lithuanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sand = "Sand", + lithuanian = "Lithuanian", /** - * Represents a green marble texture. + * Macedonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greenMarble = "GreenMarble", + macedonianFYROM = "MacedonianFYROM", /** - * Represents a white marble texture. + * Malayalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteMarble = "WhiteMarble", + malayalam = "Malayalam", /** - * Represents a brown marble texture. + * Malay Brunei Darussalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brownMarble = "BrownMarble", + malayBruneiDarussalam = "MalayBruneiDarussalam", /** - * Represents a granite texture. + * Malaysian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - granite = "Granite", + malaysian = "Malaysian", /** - * Represents a newsprint texture. + * Maltese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newsprint = "Newsprint", + maltese = "Maltese", /** - * Represents a recycled paper texture. + * Manipuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - recycledPaper = "RecycledPaper", + manipuri = "Manipuri", /** - * Represents a parchment texture. + * Marathi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + marathi = "Marathi", /** - * Represents a stationery texture. + * Mexican Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stationery = "Stationery", + mexicanSpanish = "MexicanSpanish", /** - * Represents a blue tissue paper texture. + * Mongolian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blueTissuePaper = "BlueTissuePaper", + mongolian = "Mongolian", /** - * Represents a pink tissue paper texture. + * Nepali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pinkTissuePaper = "PinkTissuePaper", + nepali = "Nepali", /** - * Represents a purple mesh texture. + * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - purpleMesh = "PurpleMesh", + noProofing = "NoProofing", /** - * Represents a bouquet texture. + * Norwegian Bokmol language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bouquet = "Bouquet", + norwegianBokmol = "NorwegianBokmol", /** - * Represents a cork texture. + * Norwegian Nynorsk language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cork = "Cork", + norwegianNynorsk = "NorwegianNynorsk", /** - * Represents a walnut texture. + * Odia (Oriya) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - walnut = "Walnut", + oriya = "Oriya", /** - * Represents an oak texture. + * Oromo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oak = "Oak", + oromo = "Oromo", /** - * Represents a medium wood texture. + * Pashto language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mediumWood = "MediumWood", - } - /** - * Specifies an extrusion (three-dimensional) format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetThreeDimensionalFormat { + pashto = "Pashto", /** - * Represents a mixed three-dimensional format. + * Persian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + persian = "Persian", /** - * Represents three-dimensional format 1. + * Polish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format1 = "Format1", + polish = "Polish", /** - * Represents three-dimensional format 2. + * Portuguese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format2 = "Format2", + portuguese = "Portuguese", /** - * Represents three-dimensional format 3. + * Portuguese (Brazil) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format3 = "Format3", + portugueseBrazil = "PortugueseBrazil", /** - * Represents three-dimensional format 4. + * Punjabi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format4 = "Format4", + punjabi = "Punjabi", /** - * Represents three-dimensional format 5. + * Rhaeto Romanic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format5 = "Format5", + rhaetoRomanic = "RhaetoRomanic", /** - * Represents three-dimensional format 6. + * Romanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format6 = "Format6", + romanian = "Romanian", /** - * Represents three-dimensional format 7. + * Romanian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format7 = "Format7", + romanianMoldova = "RomanianMoldova", /** - * Represents three-dimensional format 8. + * Russian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format8 = "Format8", + russian = "Russian", /** - * Represents three-dimensional format 9. + * Russian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format9 = "Format9", + russianMoldova = "RussianMoldova", /** - * Represents three-dimensional format 10. + * Sami Lappish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format10 = "Format10", + samiLappish = "SamiLappish", /** - * Represents three-dimensional format 11. + * Sanskrit language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format11 = "Format11", + sanskrit = "Sanskrit", /** - * Represents three-dimensional format 12. + * Serbian Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format12 = "Format12", + serbianCyrillic = "SerbianCyrillic", /** - * Represents three-dimensional format 13. + * Serbian Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format13 = "Format13", + serbianLatin = "SerbianLatin", /** - * Represents three-dimensional format 14. + * Sesotho language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format14 = "Format14", + sesotho = "Sesotho", /** - * Represents three-dimensional format 15. + * Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format15 = "Format15", + simplifiedChinese = "SimplifiedChinese", /** - * Represents three-dimensional format 16. + * Sindhi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format16 = "Format16", + sindhi = "Sindhi", /** - * Represents three-dimensional format 17. + * Sindhi (Pakistan) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format17 = "Format17", + sindhiPakistan = "SindhiPakistan", /** - * Represents three-dimensional format 18. + * Sinhalese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format18 = "Format18", + sinhalese = "Sinhalese", /** - * Represents three-dimensional format 19. + * Slovakian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format19 = "Format19", + slovak = "Slovak", /** - * Represents three-dimensional format 20. + * Slovenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format20 = "Format20", - } - /** - * Specifies the type of the {@link Word.ReflectionFormat} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReflectionType { + slovenian = "Slovenian", /** - * Represents a mixed reflection type. + * Somali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + somali = "Somali", /** - * Represents no reflection. + * Sorbian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + sorbian = "Sorbian", /** - * Represents reflection type 1. + * Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + spanish = "Spanish", /** - * Represents reflection type 2. + * Spanish Argentina language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + spanishArgentina = "SpanishArgentina", /** - * Represents reflection type 3. + * Spanish Bolivian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + spanishBolivia = "SpanishBolivia", /** - * Represents reflection type 4. + * Spanish Chilean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + spanishChile = "SpanishChile", /** - * Represents reflection type 5. + * Spanish Colombian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + spanishColombia = "SpanishColombia", /** - * Represents reflection type 6. + * Spanish Costa Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + spanishCostaRica = "SpanishCostaRica", /** - * Represents reflection type 7. + * Spanish Dominican Republic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + spanishDominicanRepublic = "SpanishDominicanRepublic", /** - * Represents reflection type 8. + * Spanish Ecuadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + spanishEcuador = "SpanishEcuador", /** - * Represents reflection type 9. + * Spanish El Salvadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", - } - /** - * Specifies the type of shadowing effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowStyle { + spanishElSalvador = "SpanishElSalvador", /** - * Represents a mixed shadow style. + * Spanish Guatemala language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + spanishGuatemala = "SpanishGuatemala", /** - * Represents an outer shadow style. + * Spanish Honduran language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outerShadow = "OuterShadow", + spanishHonduras = "SpanishHonduras", /** - * Represents an inner shadow style. + * Spanish Modern Sort language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - innerShadow = "InnerShadow", - } - /** - * Specifies the type of shadow displayed with a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowType { + spanishModernSort = "SpanishModernSort", /** - * Represents a mixed shadow type. + * Spanish Nicaraguan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + spanishNicaragua = "SpanishNicaragua", /** - * Represents shadow type 1. + * Spanish Panamanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + spanishPanama = "SpanishPanama", /** - * Represents shadow type 2. + * Spanish Paraguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + spanishParaguay = "SpanishParaguay", /** - * Represents shadow type 3. + * Spanish Peruvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + spanishPeru = "SpanishPeru", /** - * Represents shadow type 4. + * Spanish Puerto Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + spanishPuertoRico = "SpanishPuertoRico", /** - * Represents shadow type 5. + * Spanish Uruguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + spanishUruguay = "SpanishUruguay", /** - * Represents shadow type 6. + * Spanish Venezuelan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + spanishVenezuela = "SpanishVenezuela", /** - * Represents shadow type 7. + * Sutu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + sutu = "Sutu", /** - * Represents shadow type 8. + * Swahili language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + swahili = "Swahili", /** - * Represents shadow type 9. + * Swedish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", + swedish = "Swedish", /** - * Represents shadow type 10. + * Swedish Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type10 = "Type10", + swedishFinland = "SwedishFinland", /** - * Represents shadow type 11. + * Swiss French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type11 = "Type11", + swissFrench = "SwissFrench", /** - * Represents shadow type 12. + * Swiss German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type12 = "Type12", + swissGerman = "SwissGerman", /** - * Represents shadow type 13. + * Swiss Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type13 = "Type13", + swissItalian = "SwissItalian", /** - * Represents shadow type 14. + * Syriac language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type14 = "Type14", + syriac = "Syriac", /** - * Represents shadow type 15. + * Tajik language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type15 = "Type15", + tajik = "Tajik", /** - * Represents shadow type 16. + * Tamazight language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type16 = "Type16", + tamazight = "Tamazight", /** - * Represents shadow type 17. + * Tamazight Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type17 = "Type17", + tamazightLatin = "TamazightLatin", /** - * Represents shadow type 18. + * Tamil language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type18 = "Type18", + tamil = "Tamil", /** - * Represents shadow type 19. + * Tatar language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type19 = "Type19", + tatar = "Tatar", /** - * Represents shadow type 20. + * Telugu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type20 = "Type20", + telugu = "Telugu", /** - * Represents shadow type 21. + * Thai language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type21 = "Type21", + thai = "Thai", /** - * Represents shadow type 22. + * Tibetan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type22 = "Type22", + tibetan = "Tibetan", /** - * Represents shadow type 23. + * Tigrigna Eritrea language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type23 = "Type23", + tigrignaEritrea = "TigrignaEritrea", /** - * Represents shadow type 24. + * Tigrigna Ethiopic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type24 = "Type24", + tigrignaEthiopic = "TigrignaEthiopic", /** - * Represents shadow type 25. + * Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type25 = "Type25", + traditionalChinese = "TraditionalChinese", /** - * Represents shadow type 26. + * Tsonga language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type26 = "Type26", + tsonga = "Tsonga", /** - * Represents shadow type 27. + * Tswana language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type27 = "Type27", + tswana = "Tswana", /** - * Represents shadow type 28. + * Turkish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type28 = "Type28", + turkish = "Turkish", /** - * Represents shadow type 29. + * Turkmen language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type29 = "Type29", + turkmen = "Turkmen", /** - * Represents shadow type 30. + * Ukrainian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type30 = "Type30", + ukrainian = "Ukrainian", /** - * Represents shadow type 31. + * Urdu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type31 = "Type31", + urdu = "Urdu", /** - * Represents shadow type 32. + * Uzbek Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type32 = "Type32", + uzbekCyrillic = "UzbekCyrillic", /** - * Represents shadow type 33. + * Uzbek Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type33 = "Type33", + uzbekLatin = "UzbekLatin", /** - * Represents shadow type 34. + * Venda language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type34 = "Type34", + venda = "Venda", /** - * Represents shadow type 35. + * Vietnamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type35 = "Type35", + vietnamese = "Vietnamese", /** - * Represents shadow type 36. + * Welsh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type36 = "Type36", + welsh = "Welsh", /** - * Represents shadow type 37. + * Xhosa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type37 = "Type37", + xhosa = "Xhosa", /** - * Represents shadow type 38. + * Yi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type38 = "Type38", + yi = "Yi", /** - * Represents shadow type 39. + * Yiddish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type39 = "Type39", + yiddish = "Yiddish", /** - * Represents shadow type 40. + * Yoruba language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type40 = "Type40", + yoruba = "Yoruba", /** - * Represents shadow type 41. + * Zulu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type41 = "Type41", + zulu = "Zulu", + } + /** + * Specifies how a building block is inserted into a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DocPartInsertType { /** - * Represents shadow type 42. + * Inserts the content of the building block. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type42 = "Type42", + content = "Content", /** - * Represents shadow type 43. + * Inserts the building block as a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type43 = "Type43", + paragraph = "Paragraph", + /** + * Inserts the building block as a page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", } /** - * Specifies the stylistic set to apply to the font. + * Specifies the type of building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum StylisticSet { + enum BuildingBlockType { /** - * Default stylistic set. + * Represents Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + quickParts = "QuickParts", /** - * Stylistic set 01. + * Represents Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set01 = "Set01", + coverPage = "CoverPage", /** - * Stylistic set 02. + * Represents Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set02 = "Set02", + equations = "Equations", /** - * Stylistic set 03. + * Represents Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set03 = "Set03", + footers = "Footers", /** - * Stylistic set 04. + * Represents Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set04 = "Set04", + headers = "Headers", /** - * Stylistic set 05. + * Represents Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set05 = "Set05", + pageNumber = "PageNumber", /** - * Stylistic set 06. + * Represents Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set06 = "Set06", + tables = "Tables", /** - * Stylistic set 07. + * Represents Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set07 = "Set07", + watermarks = "Watermarks", /** - * Stylistic set 08. + * Represents AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set08 = "Set08", + autoText = "AutoText", /** - * Stylistic set 09. + * Represents Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set09 = "Set09", + textBox = "TextBox", /** - * Stylistic set 10. + * Represents Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set10 = "Set10", + pageNumberTop = "PageNumberTop", /** - * Stylistic set 11. + * Represents Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set11 = "Set11", + pageNumberBottom = "PageNumberBottom", /** - * Stylistic set 12. + * Represents Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set12 = "Set12", + pageNumberPage = "PageNumberPage", /** - * Stylistic set 13. + * Represents Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set13 = "Set13", + tableOfContents = "TableOfContents", /** - * Stylistic set 14. + * Represents Custom Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set14 = "Set14", + customQuickParts = "CustomQuickParts", /** - * Stylistic set 15. + * Represents Custom Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set15 = "Set15", + customCoverPage = "CustomCoverPage", /** - * Stylistic set 16. + * Represents Custom Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set16 = "Set16", + customEquations = "CustomEquations", /** - * Stylistic set 17. + * Represents Custom Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set17 = "Set17", + customFooters = "CustomFooters", /** - * Stylistic set 18. + * Represents Custom Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set18 = "Set18", + customHeaders = "CustomHeaders", /** - * Stylistic set 19. + * Represents Custom Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set19 = "Set19", + customPageNumber = "CustomPageNumber", /** - * Stylistic set 20. + * Represents Custom Tables building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set20 = "Set20", - } - /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TextureAlignment { + customTables = "CustomTables", /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents Custom Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + customWatermarks = "CustomWatermarks", /** - * Aligns the texture to the top-left corner of the shape. + * Represents Custom AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + customAutoText = "CustomAutoText", /** - * Aligns the texture to the top center of the shape. + * Represents Custom Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + customTextBox = "CustomTextBox", /** - * Aligns the texture to the top-right corner of the shape. + * Represents Custom Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + customPageNumberTop = "CustomPageNumberTop", /** - * Aligns the texture to the middle left side of the shape. + * Represents Custom Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + customPageNumberBottom = "CustomPageNumberBottom", /** - * Aligns the texture to the center of the shape. + * Represents Custom Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + customPageNumberPage = "CustomPageNumberPage", /** - * Aligns the texture to the middle right side of the shape. + * Represents Custom Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + customTableOfContents = "CustomTableOfContents", /** - * Aligns the texture to the bottom-left corner of the shape. + * Represents Custom building block type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + custom1 = "Custom1", /** - * Aligns the texture to the bottom center of the shape. + * Represents Custom building block type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + custom2 = "Custom2", /** - * Aligns the texture to the bottom-right corner of the shape. + * Represents Custom building block type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + custom3 = "Custom3", + /** + * Represents Custom building block type 4. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom4 = "Custom4", + /** + * Represents Custom building block type 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom5 = "Custom5", + /** + * Represents Bibliography building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography = "Bibliography", + /** + * Represents Custom Bibliography building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customBibliography = "CustomBibliography", } /** - * Specifies the texture type for the selected fill. + * Represents the type of a {@link Word.CustomXmlValidationError}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureType { + enum CustomXmlValidationErrorType { /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * Represents a validation error generated by the schema. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + schemaGenerated = "schemaGenerated", /** - * A predefined texture selected from the built-in texture gallery. + * Represents a validation error that is automatically cleared. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preset = "Preset", + automaticallyCleared = "automaticallyCleared", /** - * A custom texture defined by the user, typically from an image file. + * Represents a validation error that is manually created. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - userDefined = "UserDefined", + manual = "manual", } /** - * Specifies the theme colors for document themes. + * Represents the type of a {@link Word.CustomXmlNode}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ThemeColorIndex { - /** - * Not a theme color. Used when the color is not part of the theme. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - notThemeColor = "NotThemeColor", + enum CustomXmlNodeType { /** - * The first dark color in the main theme. + * Represents an XML element node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark1 = "MainDark1", + element = "element", /** - * The first light color in the main theme. + * Represents an XML attribute node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight1 = "MainLight1", + attribute = "attribute", /** - * The second dark color in the main theme. + * Represents an XML text node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark2 = "MainDark2", + text = "text", /** - * The second light color in the main theme. + * Represents an XML CDATA section node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight2 = "MainLight2", + cData = "cData", /** - * The first accent color in the theme. + * Represents an XML processing instruction node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent1 = "Accent1", + processingInstruction = "processingInstruction", /** - * The second accent color in the theme. + * Represents an XML comment node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent2 = "Accent2", + comment = "comment", /** - * The third accent color in the theme. + * Represents an XML document node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent3 = "Accent3", + document = "document", + } + /** + * Specifies the type of link. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LinkType { /** - * The fourth accent color in the theme. + * OLE object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent4 = "Accent4", + ole = "Ole", /** - * The fifth accent color in the theme. + * Picture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent5 = "Accent5", + picture = "Picture", /** - * The sixth accent color in the theme. + * Text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent6 = "Accent6", + text = "Text", /** - * The color used for hyperlinks. + * Reference library. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + reference = "Reference", /** - * The color used for followed hyperlinks. + * Include file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinkFollowed = "HyperlinkFollowed", + include = "Include", /** - * The first background color in the theme. + * Import file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background1 = "Background1", + import = "Import", /** - * The first text color in the theme. + * Dynamic Data Exchange. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text1 = "Text1", + dde = "Dde", /** - * The second background color in the theme. + * Automatic DDE. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background2 = "Background2", + ddeAuto = "DdeAuto", /** - * The second text color in the theme. + * Microsoft Excel chart. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text2 = "Text2", + chart = "Chart", } /** - * Specifies the hyperlink type. + * Specifies the action associated with the verb that the OLE object should perform. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HyperlinkType { + enum OleVerb { /** - * Represents a hyperlink to a range in the document. + * Performs the verb that is invoked when the user double-clicks the object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range = "Range", + primary = "Primary", /** - * Represents a hyperlink to a shape in the document. + * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + show = "Show", /** - * Represents a hyperlink to an inline shape in the document. + * Opens the object in a separate window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", + open = "Open", + /** + * Removes the object's user interface from view. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hide = "Hide", + /** + * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uiActivate = "UiActivate", + /** + * Runs the object and installs its window, but doesn't install any user-interface tools. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + inPlaceActivate = "InPlaceActivate", + /** + * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + discardUndoState = "DiscardUndoState", } /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). + * Represents the list formatting characteristics of a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Bibliography extends OfficeExtension.ClientObject { + class ListFormat 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; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sources: Word.SourceCollection; + readonly list: Word.List; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle: string; + readonly listTemplate: Word.ListTemplate; /** - * 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. + * Indicates whether the `ListFormat` object contains a single list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bibliography): void; + readonly isSingleList: boolean; /** - * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - generateUniqueTag(): OfficeExtension.ClientResult; + readonly isSingleListTemplate: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; + listLevelNumber: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Bibliography; + readonly listString: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the type of the list for the `ListFormat` object. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Bibliography; + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * 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. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Bibliography; + readonly listValue: number; /** - * 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. + * 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. */ - untrack(): Word.Bibliography; + set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListFormat): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + * Adds bullets and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - toJSON(): Word.Interfaces.BibliographyData; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class SourceCollection 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.Source[]; + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Adds a new `Source` object to the collection. + * Adds bullets and formatting to the paragraphs in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param xml A string containing the XML data for the source. - * @returns A `Source` object that was added to the collection. + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - add(xml: string): Word.Source; + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Gets a `Source` by its index in the collection. + * Applies a list template with a specific level to the paragraphs in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index A number that identifies the index location of a `Source` object. + * @param listTemplate The list template to apply. + * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - getItem(index: number): Word.Source; + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds numbering and formatting to the paragraphs in the range. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds numbering and formatting to the paragraphs in the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - load(propertyNames?: string | string[]): Word.SourceCollection; + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds outline numbering and formatting to the paragraphs in the range. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * 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. + * Adds outline numbering and formatting to the paragraphs in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - track(): Word.SourceCollection; + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * 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. + * Determines whether the `ListFormat` object can continue a previous list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param listTemplate The list template to check. + * @returns A `Continue` value indicating whether continuation is possible. */ - untrack(): Word.SourceCollection; + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Converts numbers in the list to plain text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType Optional. The type of number to convert. */ - toJSON(): Word.Interfaces.SourceCollectionData; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Source 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; + convertNumbersToText(numberType: Word.NumberType): void; /** - * Gets if the `Source` object has been cited in the document. + * Converts numbers in the list to plain text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to convert. */ - readonly isCited: boolean; + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Gets the tag of the source. + * Counts the numbered items in the list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. + * @returns The number of items. */ - readonly tag: string; + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Gets the XML representation of the source. + * Indents the list by one level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xml: string; + listIndent(): void; /** - * Deletes the `Source` object. + * Outdents the list by one level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + listOutdent(): void; /** - * Returns the value of a field in the bibliography `Source` object. + * Removes numbering from the list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param name The name of the field to retrieve. + * @param numberType Optional. The type of number to remove. */ - getFieldByName(name: string): OfficeExtension.ClientResult; + removeNumbers(numberType: Word.NumberType): void; + /** + * Removes numbering from the list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numberType Optional. The type of number to remove. + */ + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): 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.SourceLoadOptions): Word.Source; + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; /** * 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.Source; + load(propertyNames?: string | string[]): Word.ListFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -137849,400 +138185,471 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Source; + }): Word.ListFormat; /** * 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.Source; + track(): Word.ListFormat; /** * 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.Source; + untrack(): Word.ListFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.SourceData; + toJSON(): Word.Interfaces.ListFormatData; } /** - * Represents the page setup settings for a Word document or section. + * Represents options for counting numbered items in a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class PageSetup 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; + interface ListFormatCountNumberedItemsOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * If provided, specifies the level to count. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering: Word.LineNumbering; + level?: number; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textColumns: Word.TextColumnCollection; + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; + } + /** + * Represents options for applying a list template to a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListTemplateApplyOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + * If provided, specifies the level to apply in the list template. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting: boolean; + applyLevel?: number; /** - * Specifies the number of pages for each booklet. + * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets: number; + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * If provided, specifies whether to continue the previous list. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting: boolean; + continuePreviousList?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin: number; + defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; + } + /** + * Represents the fill formatting for a shape or text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class FillFormat 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; /** - * Specifies the number of characters per line in the document grid. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine: number; + readonly backgroundColor: Word.ColorFormat; /** - * Specifies whether the first page has a different header and footer. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter: boolean; + readonly foregroundColor: Word.ColorFormat; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance: number; + gradientAngle: number; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter: number; + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Specifies on which side the gutter appears in a document. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + readonly gradientDegree: number; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies the distance between the header and the top of the page in points. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance: number; + readonly gradientVariant: number; /** - * Specifies the layout mode for the current document. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + isVisible: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin: number; + readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies the number of lines per page in the document grid. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage: number; + readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins: boolean; + readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter: boolean; + rotateWithObject: boolean; /** - * Specifies the orientation of the page. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.PageOrientation | "Portrait" | "Landscape"; + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the page height in points. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight: number; + textureHorizontalScale: number; /** - * Specifies the page width in points. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth: number; + readonly textureName: string; /** - * Specifies the paper size of the page. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + textureOffsetX: number; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin: number; + textureOffsetY: number; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + textureTile: boolean; /** - * Specifies the type of section break for the specified object. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies whether to show the grid. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid: boolean; + textureVerticalScale: number; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes: boolean; + transparency: number; /** - * Specifies the top margin of the page in points. + * Gets the fill format type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin: number; + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; /** - * Specifies whether to print two pages per sheet. + * 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.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.FillFormat): void; + /** + * Sets the fill to a one-color gradient. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - twoPagesOnOne: boolean; + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Sets the fill to a one-color gradient. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; /** - * 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. + * Sets the fill to a pattern. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PageSetup): void; + setPatterned(pattern: Word.PatternType): void; /** - * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * Sets the fill to a pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setAsTemplateDefault(): void; + setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; /** - * Switches between portrait and landscape page orientations for a document or section. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - togglePortrait(): void; + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; + setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the fill to a preset texture. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.PageSetup; + setPresetTextured(presetTexture: Word.PresetTexture): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Sets the fill to a preset texture. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.PageSetup; + setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; /** - * 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. + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.PageSetup; + setTwoColorGradient(style: Word.GradientStyle, variant: number): void; /** - * 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. + * Sets the fill to a two-color gradient. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.PageSetup; + setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.PageSetupData; + * Sets the fill to a uniform color. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + solid(): 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.FillFormatLoadOptions): Word.FillFormat; + /** + * 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.FillFormat; + /** + * 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.FillFormat; + /** + * 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.FillFormat; + /** + * 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.FillFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FillFormatData; } /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class LineNumbering extends OfficeExtension.ClientObject { + class GlowFormat 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; /** - * Specifies the numeric increment for line numbers. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - countBy: number; - /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - distanceFromText: number; - /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive: boolean; + readonly color: Word.ColorFormat; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + radius: number; /** - * Specifies the starting line number. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber: number; + transparency: 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.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineNumbering): void; + set(properties: Word.GlowFormat): 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.LineNumberingLoadOptions): Word.LineNumbering; + load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; /** * 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.LineNumbering; + load(propertyNames?: string | string[]): Word.GlowFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -138251,241 +138658,265 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.LineNumbering; + }): Word.GlowFormat; /** * 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.LineNumbering; + track(): Word.GlowFormat; /** * 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.LineNumbering; + untrack(): Word.GlowFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.LineNumberingData; + toJSON(): Word.Interfaces.GlowFormatData; } /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class TextColumnCollection extends OfficeExtension.ClientObject { + class LineFormat 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.TextColumn[]; /** - * Returns a `TextColumn` object that represents a new text column added to a section or document. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for configuring the new text column. - * @returns A `TextColumn` object that represents a new text column added to the document. */ - add(options?: Word.TextColumnAddOptions): Word.TextColumn; + readonly backgroundColor: Word.ColorFormat; /** - * Gets the direction in which text flows from one text column to the next. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFlowDirection(): OfficeExtension.ClientResult; + readonly foregroundColor: Word.ColorFormat; /** - * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getHasLineBetween(): OfficeExtension.ClientResult; + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Gets whether text columns are evenly spaced. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getIsEvenlySpaced(): OfficeExtension.ClientResult; + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gets a `TextColumn` by its index in the collection. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `TextColumn` object. */ - getItem(index: number): Word.TextColumn; + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Arranges text into the specified number of text columns. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + /** + * Specifies the length of the arrowhead at the end of the line. * - * @param numColumns The number of columns the text is to be arranged into. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCount(numColumns: number): void; + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Sets the direction in which text flows from one text column to the next. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + /** + * Specifies the width of the arrowhead at the end of the line. * - * @param value The flow direction to set. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setFlowDirection(value: Word.FlowDirection): void; + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Sets the direction in which text flows from one text column to the next. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + insetPen: boolean; + /** + * Specifies if the object, or the formatting applied to it, is visible. * - * @param value The flow direction to set. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + isVisible: boolean; /** - * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + /** + * Specifies the line format style. * - * @param value `true` to show vertical lines between columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setHasLineBetween(value: boolean): void; + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Sets whether text columns are evenly spaced. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + transparency: number; + /** + * Specifies the thickness of the line in points. * - * @param value `true` to evenly space all the text columns in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setIsEvenlySpaced(value: boolean): void; + weight: 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.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineFormat): 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.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; + load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; /** * 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.TextColumnCollection; + load(propertyNames?: string | string[]): Word.LineFormat; /** * 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.TextColumnCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineFormat; /** * 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.TextColumnCollection; + track(): Word.LineFormat; /** * 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.TextColumnCollection; + untrack(): Word.LineFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TextColumnCollectionData; + toJSON(): Word.Interfaces.LineFormatData; } /** - * Represents options for a new text column in a document or section of a document. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TextColumnAddOptions { + class ReflectionFormat 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; /** - * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEvenlySpaced?: boolean; + blur: number; /** - * If provided, specifies the spacing between the text columns in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + offset: number; /** - * If provided, specifies the width of the new text column in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TextColumn 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; + size: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter: number; + transparency: number; /** - * Specifies the width, in points, of the specified text columns. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width: number; + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; /** * 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.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextColumn): void; + set(properties: Word.ReflectionFormat): 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.TextColumnLoadOptions): Word.TextColumn; + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; /** * 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.TextColumn; + load(propertyNames?: string | string[]): Word.ReflectionFormat; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -138494,12073 +138925,19561 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TextColumn; + }): Word.ReflectionFormat; /** * 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.TextColumn; + track(): Word.ReflectionFormat; /** * 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.TextColumn; + untrack(): Word.ReflectionFormat; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TextColumnData; + toJSON(): Word.Interfaces.ReflectionFormatData; } /** - * Specifies the case of the text in the specified range. + * Represents the color formatting of a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CharacterCase { + class ColorFormat 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; /** - * Specifies the next case. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + brightness: number; /** - * Specifies lowercase. + * Specifies the theme color for a color format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lower = "Lower", + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies uppercase. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upper = "Upper", + rgb: string; /** - * Specifies title case for each word. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleWord = "TitleWord", + tintAndShade: number; /** - * Specifies title case for the sentence. + * Returns the shape color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleSentence = "TitleSentence", + readonly type: Word.ColorType | "rgb" | "scheme"; /** - * Specifies toggle case. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - toggle = "Toggle", + set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ColorFormat): void; /** - * Specifies half-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - halfWidth = "HalfWidth", + load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; /** - * Specifies full-width characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fullWidth = "FullWidth", + load(propertyNames?: string | string[]): Word.ColorFormat; /** - * Specifies Katakana characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - katakana = "Katakana", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ColorFormat; /** - * Specifies Hiragana characters. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - hiragana = "Hiragana", + track(): Word.ColorFormat; + /** + * 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.ColorFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ColorFormatData; } /** - * Specifies the character width of the text in the specified range. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CharacterWidth { + class ShadowFormat 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; /** - * Specifies half-width characters. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - half = "Half", + readonly foregroundColor: Word.ColorFormat; /** - * Specifies full-width characters. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the seek view options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SeekView { + blur: number; /** - * Main document. + * Specifies whether the object or the formatting applied to it is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDocument = "MainDocument", + isVisible: boolean; /** - * Primary header. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + obscured: boolean; /** - * First page header. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + offsetX: number; /** - * Even pages header. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + offsetY: number; /** - * Primary footer. + * Specifies whether to rotate the shadow when rotating the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + rotateWithShape: boolean; /** - * First page footer. + * Specifies the width of the shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + size: number; /** - * Even pages footer. + * Specifies the type of shadow formatting to apply to a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Footnotes. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + transparency: number; /** - * Endnotes. + * Specifies the shape shadow type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; /** - * Current page header. + * 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.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShadowFormat): void; + /** + * Changes the horizontal offset of the shadow by the number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + incrementOffsetX(increment: number): void; /** - * Current page footer. + * Changes the vertical offset of the shadow by the specified number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + incrementOffsetY(increment: number): 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.ShadowFormatLoadOptions): Word.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * 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.ShadowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShadowFormatData; } /** - * Specifies the source documents to show. + * Represents a shape's three-dimensional formatting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ShowSourceDocuments { + class ThreeDimensionalFormat 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; /** - * Specifies that no source documents are shown. + * Returns a `ColorFormat` object that represents color of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly contourColor: Word.ColorFormat; /** - * Specifies that the original source document is shown. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + readonly extrusionColor: Word.ColorFormat; /** - * Specifies that the revised source document is shown. + * Specifies the depth of the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revised = "Revised", + bevelBottomDepth: number; /** - * Specifies that both the original and revised source documents are shown. + * Specifies the inset size for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - both = "Both", - } - /** - * Specifies the special pane options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SpecialPane { + bevelBottomInset: number; /** - * None. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Primary header. + * Specifies the depth of the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + bevelTopDepth: number; /** - * First page header. + * Specifies the inset size for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + bevelTopInset: number; /** - * Even pages header. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Primary footer. + * Specifies the width of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + contourWidth: number; /** - * First page footer. + * Specifies the depth of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + depth: number; /** - * Even pages footer. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Footnotes. + * Specifies the amount of perspective for a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + fieldOfView: number; /** - * Endnotes. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + isPerspective: boolean; /** - * Footnote continuation notice. + * Specifies if the specified object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + isVisible: boolean; /** - * Footnote continuation separator. + * Specifies the angle of the lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + lightAngle: number; /** - * Footnote separator. + * Returns a `PresetCamera` value that represents the camera presets. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Endnote continuation notice. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Endnote continuation separator. + * Specifies a `LightRigType` value that represents the lighting preset. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Endnote separator. + * Specifies the position of the light source relative to the extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Comments. + * Specifies the intensity of the extrusion lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Current page header. + * Specifies the extrusion surface material. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Current page footer. + * Returns the preset extrusion format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Revisions. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisions = "Revisions", + projectText: boolean; /** - * Revisions horizontal. + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsHoriz = "RevisionsHoriz", + rotationX: number; /** - * Revisions vertical. + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsVert = "RevisionsVert", - } - /** - * Specifies the save options. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SaveConfiguration { + rotationY: number; /** - * Specifies not to save changes. + * Specifies the z-axis rotation of the camera. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doNotSaveChanges = "DoNotSaveChanges", + rotationZ: number; /** - * Specifies to save changes. + * Specifies the position on the z-axis for the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saveChanges = "SaveChanges", + z: number; /** - * Specifies to prompt to save changes. + * 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.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ThreeDimensionalFormat): void; + /** + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - promptToSaveChanges = "PromptToSaveChanges", - } - /** - * Specifies the page color options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageColor { + incrementRotationHorizontal(increment: number): void; /** - * None. + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + incrementRotationVertical(increment: number): void; /** - * Sepia. + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sepia = "Sepia", + incrementRotationX(increment: number): void; /** - * Inverse. + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inverse = "Inverse", - } - /** - * Specifies the page movement type in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageMovementType { + incrementRotationY(increment: number): void; /** - * Vertical. + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + incrementRotationZ(increment: number): void; /** - * Side to side. + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sideToSide = "SideToSide", - } - /** - * Specifies the margin options in reading layout view in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingLayoutMargin { + resetRotation(): void; /** - * Microsoft Word determines automatically whether to show or hide the margins based on the available space. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - automatic = "Automatic", + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; /** - * Hides margins. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - suppress = "Suppress", + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; /** - * Shows margins. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the margin for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonMargin { + setPresetCamera(presetCamera: Word.PresetCamera): void; /** - * Left margin. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; /** - * Right margin. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + /** + * Sets the preset extrusion format. + The preset format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): 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.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * 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.ThreeDimensionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ThreeDimensionalFormatData; } /** - * Specifies the width type for revision balloons in a Word document. + * Specifies the length of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionsBalloonWidthType { + enum ArrowheadLength { /** - * Balloon width as a percentage. + * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + mixed = "Mixed", /** - * Balloon width in points. + * Represents a short arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", + short = "Short", + /** + * Represents a medium arrowhead length. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Represents a long arrowhead length. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + long = "Long", } /** - * Specifies the extent of markup visible in the document. + * Specifies the style of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionsMarkup { + enum ArrowheadStyle { /** - * No markup. + * Represents a mixed arrowhead style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mixed = "Mixed", + /** + * Represents no arrowhead. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Simple markup. + * Represents a triangle arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", + triangle = "Triangle", /** - * All markup. + * Represents an open arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", - } - /** - * Specifies the display mode for tracked changes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMode { + open = "Open", /** - * Balloon. + * Represents a stealth arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloon = "Balloon", + stealth = "Stealth", /** - * Inline. + * Represents a diamond arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + diamond = "Diamond", /** - * Mixed. + * Represents an oval arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + oval = "Oval", } /** - * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. + * Specifies the width of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionsView { + enum ArrowheadWidth { /** - * Final view. + * Represents a mixed arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - final = "Final", + mixed = "Mixed", /** - * Original view. + * Represents a narrow arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + narrow = "Narrow", + /** + * Represents a medium arrowhead width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Represents a wide arrowhead width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wide = "Wide", } /** - * Specifies the revision type. + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionType { + enum BevelType { /** - * No revision. + * Represents a mixed bevel type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + mixed = "mixed", /** - * Insert revision. + * Represents no bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insert = "Insert", + none = "none", /** - * Delete revision. + * Represents a relaxed inset bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete = "Delete", + relaxedInset = "relaxedInset", /** - * Property revision. + * Represents a circle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - property = "Property", + circle = "circle", /** - * Paragraph number revision. + * Represents a slope bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphNumber = "ParagraphNumber", + slope = "slope", /** - * Display field revision. + * Represents a cross bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - displayField = "DisplayField", + cross = "cross", /** - * Reconcile revision. + * Represents an angle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reconcile = "Reconcile", + angle = "angle", /** - * Conflict revision. + * Represents a soft round bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflict = "Conflict", + softRound = "softRound", /** - * Style revision. + * Represents a convex bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style = "Style", + convex = "convex", /** - * Replace revision. + * Represents a cool slant bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replace = "Replace", + coolSlant = "coolSlant", /** - * Paragraph property revision. + * Represents a divot bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphProperty = "ParagraphProperty", + divot = "divot", /** - * Table property revision. + * Represents a riblet bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableProperty = "TableProperty", + riblet = "riblet", /** - * Section property revision. + * Represents a hard edge bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionProperty = "SectionProperty", + hardEdge = "hardEdge", /** - * Style definition revision. + * Represents an art deco bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleDefinition = "StyleDefinition", + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorIndex { /** - * Moved from revision. + * Automatically determines the color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedFrom = "MovedFrom", + auto = "Auto", /** - * Moved to revision. + * Represents the color black. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedTo = "MovedTo", + black = "Black", /** - * Cell insertion revision. + * Represents the color blue. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellInsertion = "CellInsertion", + blue = "Blue", /** - * Cell deletion revision. + * Represents the color turquoise. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellDeletion = "CellDeletion", + turquoise = "Turquoise", /** - * Cell merge revision. + * Represents a bright green color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellMerge = "CellMerge", + brightGreen = "BrightGreen", /** - * Cell split revision. + * Represents the color pink. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellSplit = "CellSplit", + pink = "Pink", /** - * Conflict insert revision. + * Represents the color red. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictInsert = "ConflictInsert", + red = "Red", /** - * Conflict delete revision. + * Represents the color yellow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictDelete = "ConflictDelete", - } - /** - * Specifies the column width options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColumnWidth { + yellow = "Yellow", /** - * Narrow column width. + * Represents the color white. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + white = "White", /** - * Default column width. + * Represents a dark blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + darkBlue = "DarkBlue", /** - * Wide column width. + * Represents the color teal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", - } - /** - * Specifies the field shading options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FieldShading { + teal = "Teal", /** - * Never shade fields. + * Represents the color green. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - never = "Never", + green = "Green", /** - * Always shade fields. + * Represents the color violet. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - always = "Always", + violet = "Violet", /** - * Shade fields when selected. + * Represents a dark red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whenSelected = "WhenSelected", + darkRed = "DarkRed", + /** + * Represents a dark yellow color. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + darkYellow = "DarkYellow", + /** + * Represents a gray color with 50% intensity. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gray50 = "Gray50", + /** + * Represents a gray color with 25% intensity. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gray25 = "Gray25", + /** + * Represents a classic red color. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classicRed = "ClassicRed", + /** + * Represents a classic blue color. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classicBlue = "ClassicBlue", + /** + * Represents a color determined by the author. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + byAuthor = "ByAuthor", } /** - * Specifies the format for horizontal text set within vertical text. + * Specifies the color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HorizontalInVerticalType { - /** - * No formatting is applied to the horizontal text. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + enum ColorType { /** - * The horizontal text is sized to fit in the line of vertical text. + * Represents an RGB color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitInLine = "FitInLine", + rgb = "rgb", /** - * The line of vertical text is sized to accommodate the horizontal text. + * Represents a scheme color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resizeLine = "ResizeLine", + scheme = "scheme", } /** - * Specifies the IME (Input Method Editor) mode. + * Specifies whether the formatting from the previous list can be continued. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ImeMode { + enum Continue { /** - * Specifies no control over the IME mode. + * Formatting cannot continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noControl = "NoControl", + disabled = "Disabled", /** - * Specifies the IME mode is on. + * Formatting can continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - on = "On", + list = "List", /** - * Specifies the IME mode is off. + * Numbering can be restarted. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - off = "Off", + reset = "Reset", + } + /** + * Specifies the default list behavior for a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultListBehavior { /** - * Specifies the Hiragana IME mode. + * Use formatting compatible with Microsoft Word 97. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + word97 = "Word97", /** - * Specifies the Katakana (double-byte) IME mode. + * Use Web-oriented formatting as introduced in Microsoft Word 2000. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + word2000 = "Word2000", /** - * Specifies the Katakana (half-width) IME mode. + * Use formatting compatible with Microsoft Word 2002. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakanaHalf = "KatakanaHalf", + word2002 = "Word2002", + } + /** + * Specifies the type of emphasis mark to use for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EmphasisMark { /** - * Specifies the full-width alphanumeric IME mode. + * No emphasis mark. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphaFull = "AlphaFull", + none = "None", /** - * Specifies the half-width alphanumeric IME mode. + * Emphasis mark over a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alpha = "Alpha", + overSolidCircle = "OverSolidCircle", /** - * Specifies the full-width Hangul IME mode. + * Emphasis mark over a comma. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangulFull = "HangulFull", + overComma = "OverComma", /** - * Specifies the half-width Hangul IME mode. + * Emphasis mark over a white circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangul = "Hangul", + overWhiteCircle = "OverWhiteCircle", + /** + * Emphasis mark under a solid circle. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underSolidCircle = "UnderSolidCircle", } /** - * Specifies the Kana type. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum Kana { + enum ExtrusionColorType { /** - * Katakana Kana type. + * Represents a mixed extrusion color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + mixed = "mixed", /** - * Hiragana Kana type. + * Represents an automatic extrusion color based on the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + automatic = "automatic", + /** + * Represents a custom extrusion color independent of the shape's fill. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "custom", } /** - * Specifies the two lines in one type. + * Specifies a shape's fill type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TwoLinesInOneType { + enum FillType { /** - * No two lines in one. + * Represents a mixed fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + mixed = "Mixed", /** - * Two lines in one without brackets. + * Represents a solid fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noBrackets = "NoBrackets", + solid = "Solid", /** - * Two lines in one with parentheses. + * Represents a patterned fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentheses = "Parentheses", + patterned = "Patterned", /** - * Two lines in one with square brackets. + * Represents a gradient fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareBrackets = "SquareBrackets", + gradient = "Gradient", /** - * Two lines in one with angle brackets. + * Represents a textured fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angleBrackets = "AngleBrackets", + textured = "Textured", /** - * Two lines in one with curly brackets. + * Represents a background fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - curlyBrackets = "CurlyBrackets", + background = "Background", + /** + * Represents a picture fill type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + picture = "Picture", } /** - * Specifies the underline type. + * Specifies the type of gradient used in a shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum Underline { + enum GradientColorType { /** - * No underline. + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + mixed = "Mixed", /** - * Single underline. + * Gradient with a single color and varying transparency or brightness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + oneColor = "OneColor", /** - * Underline words only. + * Gradient that blends two distinct colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - words = "Words", + twoColors = "TwoColors", /** - * Double underline. + * Gradient that uses a predefined set of colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + presetColors = "PresetColors", /** - * Dotted underline. + * Gradient that includes more than two colors, often customized. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotted = "Dotted", + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientStyle { /** - * Thick underline. + * Represents a mixed gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thick = "Thick", + mixed = "Mixed", /** - * Dash underline. + * Represents a horizontal gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + horizontal = "Horizontal", /** - * Dot dash underline. + * Represents a vertical gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDash = "DotDash", + vertical = "Vertical", /** - * Dot dot dash underline. + * Represents a diagonal-up gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDash = "DotDotDash", + diagonalUp = "DiagonalUp", /** - * Wavy underline. + * Represents a diagonal-down gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavy = "Wavy", + diagonalDown = "DiagonalDown", /** - * Heavy wavy underline. + * Represents a gradient style from the corner. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavyHeavy = "WavyHeavy", + fromCorner = "FromCorner", /** - * Heavy dotted underline. + * Represents a gradient style from the title. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedHeavy = "DottedHeavy", + fromTitle = "FromTitle", /** - * Heavy dash underline. + * Represents a gradient style from the center. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashHeavy = "DashHeavy", + fromCenter = "FromCenter", + } + /** + * Specifies the type of ligature applied to a font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Ligature { /** - * Heavy dot dash underline. + * No ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDashHeavy = "DotDashHeavy", + none = "None", /** - * Heavy dot dot dash underline. + * Standard ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDashHeavy = "DotDotDashHeavy", + standard = "Standard", /** - * Long dash underline. + * Contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLong = "DashLong", + contextual = "Contextual", /** - * Heavy long dash underline. + * Standard and contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLongHeavy = "DashLongHeavy", + standardContextual = "StandardContextual", /** - * Double wavy underline. + * Historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wavyDouble = "WavyDouble", - } - /** - * Specifies the view type in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ViewType { + historical = "Historical", /** - * Normal. + * Standard and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + standardHistorical = "StandardHistorical", /** - * Outline. + * Contextual and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline = "Outline", + contextualHistorical = "ContextualHistorical", /** - * Print. + * Standard, contextual, and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - print = "Print", + standardContextualHistorical = "StandardContextualHistorical", /** - * Print preview. + * Discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - printPreview = "PrintPreview", + discretional = "Discretional", /** - * Master. + * Standard and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - master = "Master", + standardDiscretional = "StandardDiscretional", /** - * Web. + * Contextual and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web = "Web", + contextualDiscretional = "ContextualDiscretional", /** - * Reading. + * Standard, contextual, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading = "Reading", + standardContextualDiscretional = "StandardContextualDiscretional", /** - * Conflict. + * Historical and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflict = "Conflict", - } - /** - * Represents the state of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowState { + historicalDiscretional = "HistoricalDiscretional", /** - * Represents the normal state of the window. + * Standard, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + standardHistoricalDiscretional = "StandardHistoricalDiscretional", /** - * Represents the maximized state of the window. + * Contextual, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - maximize = "Maximize", + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", /** - * Represents the minimized state of the window. + * All ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - minimize = "Minimize", + all = "All", } /** - * Specifies the type of the window. + * Indicates the effects lighting for an object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum WindowType { + enum LightRigType { /** - * Specifies a document window. + * Represents a mixed light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "Document", + mixed = "Mixed", /** - * Specifies a template window. + * Represents legacy flat light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", - } - /** - * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionConvertToTableOptions { + legacyFlat1 = "LegacyFlat1", /** - * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. - * + * Represents legacy flat light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyBorders?: boolean; + legacyFlat2 = "LegacyFlat2", /** - * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. - * + * Represents legacy flat light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyColor?: boolean; + legacyFlat3 = "LegacyFlat3", /** - * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. - * + * Represents legacy flat light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFirstColumn?: boolean; + legacyFlat4 = "LegacyFlat4", /** - * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. - * + * Represents legacy normal light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFont?: boolean; + legacyNormal1 = "LegacyNormal1", /** - * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. - * + * Represents legacy normal light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyHeadingRows?: boolean; + legacyNormal2 = "LegacyNormal2", /** - * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. - * + * Represents legacy normal light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastColumn?: boolean; + legacyNormal3 = "LegacyNormal3", /** - * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. - * + * Represents legacy normal light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastRow?: boolean; + legacyNormal4 = "LegacyNormal4", /** - * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. - * + * Represents legacy harsh light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyShading?: boolean; + legacyHarsh1 = "LegacyHarsh1", /** - * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. - * + * Represents legacy harsh light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit?: boolean; + legacyHarsh2 = "LegacyHarsh2", /** - * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. - * + * Represents legacy harsh light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; + legacyHarsh3 = "LegacyHarsh3", /** - * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. - * + * Represents legacy harsh light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; + legacyHarsh4 = "LegacyHarsh4", /** - * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. - * + * Represents a three-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + threePoint = "ThreePoint", /** - * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. - * + * Represents a balanced light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - initialColumnWidth?: number; + balanced = "Balanced", /** - * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. - * + * Represents a soft light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numColumns?: number; + soft = "Soft", /** - * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. - * + * Represents a harsh light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numRows?: number; + harsh = "Harsh", /** - * If provided, specifies the character used to separate text into cells. The default value is `-`. - * + * Represents a flood light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separator?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.delete} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionDeleteOptions { + flood = "Flood", /** - * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. - * + * Represents a contrasting light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + contrasting = "Contrasting", /** - * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. - * + * Represents a morning light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; - } - /** - * Represents the options for the {@link Word.Selection | Selection.goTo} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionGoToOptions { + morning = "Morning", /** - * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. - * + * Represents a sunrise light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + sunrise = "Sunrise", /** - * If provided, specifies the direction the range or selection is moved to. The default value is `next`. - * + * Represents a sunset light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; + sunset = "Sunset", /** - * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. - * + * Represents a chilly light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + chilly = "Chilly", /** - * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. - * + * Represents a freezing light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionInsertCrossReferenceOptions { + freezing = "Freezing", /** - * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. - * + * Represents a flat light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - includePosition?: boolean; + flat = "Flat", /** - * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. - * + * Represents a two-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsHyperlink?: boolean; + twoPoint = "TwoPoint", /** - * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) - * + * Represents a glow light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateNumbers?: boolean; + glow = "Glow", /** - * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". - * + * Represents a bright room light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separatorString?: string; + brightRoom = "BrightRoom", } /** - * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. + * Specifies the dash style for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionInsertDateTimeOptions { + enum LineDashStyle { /** - * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents a mixed dash style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; + mixed = "Mixed", /** - * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents a solid line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; + solid = "Solid", /** - * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. - * + * Represents a square dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateTimeFormat?: string; + squareDot = "SquareDot", /** - * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. - * + * Represents a round dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsField?: boolean; + roundDot = "RoundDot", /** - * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. - * + * Represents a dashed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertAsFullWidth?: boolean; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertFormula} method - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionInsertFormulaOptions { + dash = "Dash", /** - * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. - The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. - - - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. - - - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. - - - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. - - - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. - * + * Represents a dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formula?: string; + dashDot = "DashDot", /** - * If provided, specifies the format for the result of the `= (Formula)` field. - * + * Represents a dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberFormat?: string; - } - /** - * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SelectionInsertSymbolOptions { + dashDotDot = "DashDotDot", /** - * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. - * + * Represents a long dash line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; + longDash = "LongDash", /** - * If provided, specifies the name of the font that contains the symbol. - * + * Represents a long dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - font?: string; + longDashDot = "LongDashDot", /** - * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. - * + * Represents a long dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unicode?: boolean; + longDashDotDot = "LongDashDotDot", + /** + * Represents a system dash line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDash = "SysDash", + /** + * Represents a system dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDot = "SysDot", + /** + * Represents a system dash-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDashDot = "SysDashDot", } /** - * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. + * Specifies the style for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionMoveLeftRightOptions { + enum LineFormatStyle { /** - * If provided, specifies the number of units the selection is to be moved. The default value is 1. - * + * Represents a mixed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + mixed = "Mixed", /** - * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. - * + * Represents a single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend?: Word.MovementType | "Move" | "Extend"; + single = "Single", /** - * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. - * + * Represents a thin-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + thinThin = "ThinThin", + /** + * Represents a thin-thick line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thinThick = "ThinThick", + /** + * Represents a thick-thin line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thickThin = "ThickThin", + /** + * Represents a thick line between two thin lines style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thickBetweenThin = "ThickBetweenThin", } /** - * Represents the options for the {@link Word.Selection | Selection.move} method. + * Specifies the portion of a list to which to apply a list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionMoveOptions { + enum ListApplyTo { /** - * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. - * + * Applies the list template to the entire list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + wholeList = "WholeList", /** - * If provided, specifies the unit by which to move the ending character position. The default value is `character`. - * + * Applies the list template from the cursor insertion point to the end of the list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + thisPointForward = "ThisPointForward", + /** + * Applies the list template to the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selection = "Selection", } /** - * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * Represents the list type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionMoveStartEndOptions { + enum ListType { /** - * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. - * + * List with no bullets, numbering, or outlining. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + listNoNumbering = "ListNoNumbering", /** - * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. - * + * ListNum fields that can be used in the body of a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + listListNumOnly = "ListListNumOnly", + /** + * Bulleted list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listBullet = "ListBullet", + /** + * Simple numeric list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listSimpleNumbering = "ListSimpleNumbering", + /** + * Outlined list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listOutlineNumbering = "ListOutlineNumbering", + /** + * Mixed numeric list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listMixedNumbering = "ListMixedNumbering", + /** + * Picture bulleted list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listPictureBullet = "ListPictureBullet", } /** - * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. + * Specifies the number form setting for an OpenType font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionMoveUpDownOptions { + enum NumberForm { /** - * If provided, specifies the number of units the selection is to be moved. The default value is 1. - * + * Default number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + default = "Default", /** - * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. - * + * Lining number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend?: Word.MovementType | "Move" | "Extend"; + lining = "Lining", /** - * If provided, specifies the unit by which to move the selection. The default value is `line`. - * + * Old-style number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + oldStyle = "OldStyle", } /** - * Represents the options for the {@link Word.Selection | Selection.next} method. + * Specifies the number spacing setting for an OpenType font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionNextOptions { + enum NumberSpacing { /** - * If provided, specifies the number of units by which you want to move ahead. The default value is 1. - * + * Default number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + default = "Default", /** - * If provided, specifies the type of units by which to move the selection. The default value is `character`. - * + * Proportional number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + proportional = "Proportional", + /** + * Tabular number spacing setting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabular = "Tabular", } /** - * Represents the options for the {@link Word.Selection | Selection.previous} method. + * Specifies the type of numbers in a list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SelectionPreviousOptions { + enum NumberType { /** - * If provided, specifies the number of units by which you want to move. The default value is 1. - * + * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - count?: number; + paragraph = "Paragraph", /** - * If provided, specifies the type of unit by which to move the selection. The default value is `character`. - * + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + listNum = "ListNum", + /** + * Default value for all other cases. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allNumbers = "AllNumbers", } /** - * Represents a selected range or the insertion point in a Word document. - - - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. + * Specifies the fill pattern used in a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Selection 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; + enum PatternType { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. - * + * Represents a mixed pattern type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly borders: Word.BorderUniversalCollection; + mixed = "Mixed", /** - * Returns a `RangeScopedCollection` object that represents each character in the selection. - * + * Represents a 5 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly characters: Word.RangeScopedCollection; + percent5 = "Percent5", /** - * Returns a `CommentCollection` object that represents all the comments in the selection. - * + * Represents a 10 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: Word.CommentCollection; + percent10 = "Percent10", /** - * Returns a `FieldCollection` object that represents all the fields in the selection. - * + * Represents a 20 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fields: Word.FieldCollection; + percent20 = "Percent20", /** - * Returns the `Font` object that represents the character formatting of the selection. - * + * Represents a 25 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly font: Word.Font; + percent25 = "Percent25", /** - * Specifies a `Range` object that includes the formatted text in the range or selection. - * + * Represents a 30 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formattedText: Word.Range; + percent30 = "Percent30", /** - * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. - * + * Represents a 40 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly paragraphs: Word.ParagraphCollection; + percent40 = "Percent40", /** - * Returns the `Range` object for the portion of the document contained in the selection. - * + * Represents a 50 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + percent50 = "Percent50", /** - * Returns the `SectionCollection` object in the selection. - * + * Represents a 60 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sections: Word.SectionCollection; + percent60 = "Percent60", /** - * Returns the `RangeScopedCollection` object for each sentence in the selection. - * + * Represents a 70 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sentences: Word.RangeScopedCollection; + percent70 = "Percent70", /** - * Returns the `ShadingUniversal` object for the shading formatting for the selection. - * + * Represents a 75 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + percent75 = "Percent75", /** - * Returns the `TableCollection` object in the selection. - * + * Represents an 80 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly tables: Word.TableCollection; + percent80 = "Percent80", /** - * Returns the tables at the outermost nesting level in the current selection. - * + * Represents a 90 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly topLevelTables: Word.TableCollection; + percent90 = "Percent90", /** - * Returns the `RangeScopedCollection` object that represents each word in the selection. - * + * Represents a dark horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly words: Word.RangeScopedCollection; + darkHorizontal = "DarkHorizontal", /** - * Specifies the ending character position of the selection. - * + * Represents a dark vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end: number; + darkVertical = "DarkVertical", /** - * Specifies the width in which Word fits the text in the current selection. - * + * Represents a dark downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth: number; + darkDownwardDiagonal = "DarkDownwardDiagonal", /** - * Returns whether the spelling and grammar checker ignores the selected text. - If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. - * + * Represents a dark upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly hasNoProofing: boolean; + darkUpwardDiagonal = "DarkUpwardDiagonal", /** - * Returns whether the selection in the specified window or pane is active. - * + * Represents a small checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isActive: boolean; + smallCheckerBoard = "SmallCheckerBoard", /** - * Specifies whether column selection mode is active. - * + * Represents a trellis fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isColumnSelectModeActive: boolean; + trellis = "Trellis", /** - * Returns whether the selection is at the end-of-row mark in a table. - * + * Represents a light horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isEndOfRowMark: boolean; + lightHorizontal = "LightHorizontal", /** - * Specifies whether Extend mode is active. - * + * Represents a light vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtendModeActive: boolean; + lightVertical = "LightVertical", /** - * Returns whether the insertion point is at the end of a line. - * + * Represents a light downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isInsertionPointAtEndOfLine: boolean; + lightDownwardDiagonal = "LightDownwardDiagonal", /** - * Specifies whether the beginning of the selection is active. - * + * Represents a light upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive: boolean; + lightUpwardDiagonal = "LightUpwardDiagonal", /** - * Specifies whether Word has detected the language of the selected text. - * + * Represents a small grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected: boolean; + smallGrid = "SmallGrid", /** - * Returns the language for the selection. - * + * Represents a dotted diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + dottedDiamond = "DottedDiamond", /** - * Returns the East Asian language for the selection. - * + * Represents a wide downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + wideDownwardDiagonal = "WideDownwardDiagonal", /** - * Returns the language for the selection that isn't classified as an East Asian language. - * + * Represents a wide upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + wideUpwardDiagonal = "WideUpwardDiagonal", /** - * Specifies the orientation of text in the selection. - * + * Represents a dashed upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + dashedUpwardDiagonal = "DashedUpwardDiagonal", /** - * Specifies the starting character position of the selection. - * + * Represents a dashed downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start: number; + dashedDownwardDiagonal = "DashedDownwardDiagonal", /** - * Returns the number of characters in the story that contains the selection. - * + * Represents a narrow vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyLength: number; + narrowVertical = "NarrowVertical", /** - * Returns the story type for the selection. - * + * Represents a narrow horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + narrowHorizontal = "NarrowHorizontal", /** - * Specifies the text in the selection. - * + * Represents a dashed vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text: string; + dashedVertical = "DashedVertical", /** - * Returns the selection type. - * + * Represents a dashed horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + dashedHorizontal = "DashedHorizontal", /** - * Calculates the first mathematical expression within the selection. - * + * Represents a large confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The result of the calculation. */ - calculate(): OfficeExtension.ClientResult; + largeConfetti = "LargeConfetti", /** - * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. - * + * Represents a large grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cancelMode(): void; + largeGrid = "LargeGrid", /** - * Removes character formatting applied through character styles. - * + * Represents a horizontal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearCharacterStyleFormatting(): void; + horizontalBrick = "HorizontalBrick", /** - * Removes character and paragraph formatting from the selection. - * + * Represents a large checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearFormatting(): void; + largeCheckerBoard = "LargeCheckerBoard", /** - * Removes manually applied character formatting from the selected text. - * + * Represents a small confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearManualCharacterFormatting(): void; + smallConfetti = "SmallConfetti", /** - * Removes manually applied paragraph formatting from the selected text. - * + * Represents a zigzag fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearManualParagraphFormatting(): void; + zigZag = "ZigZag", /** - * Removes all paragraph formatting from the selected text. - * + * Represents a solid diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearParagraphFormatting(): void; + solidDiamond = "SolidDiamond", /** - * Removes paragraph formatting applied through paragraph styles. - * + * Represents a diagonal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clearParagraphStyle(): void; + diagonalBrick = "DiagonalBrick", /** - * Collapses the selection to the starting or ending position. - * + * Represents an outlined diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param direction Optional. Direction to collapse. */ - collapse(direction?: Word.CollapseDirection): void; + outlinedDiamond = "OutlinedDiamond", /** - * Collapses the selection to the starting or ending position. - * + * Represents a plaid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param direction Optional. Direction to collapse. */ - collapse(direction?: "Start" | "End"): void; + plaid = "Plaid", /** - * Converts text within a range to a table. - * + * Represents a sphere fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for converting text to a table. - * @returns A `Table` object that represents the newly created table. */ - convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + sphere = "Sphere", /** - * Copies the selection to the Clipboard as a picture. - * + * Represents a weave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyAsPictureToClipboard(): void; + weave = "Weave", /** - * Copies the character formatting of the first character in the selected text. - * + * Represents a dotted grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyFormat(): void; + dottedGrid = "DottedGrid", /** - * Copies the selection to the Clipboard. - * + * Represents a divot fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copyToClipboard(): void; + divot = "Divot", /** - * Adds a default-sized text box around the selection. - * + * Represents a shingle fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - createTextBox(): void; + shingle = "Shingle", /** - * Removes the selected content from the document and moves it to the Clipboard. - * + * Represents a wave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + wave = "Wave", /** - * Deletes the specified number of characters or words. - * + * Represents a horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for deleting text. - * @returns The number of characters deleted. */ - delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + horizontal = "Horizontal", /** - * Analyzes the selected text to determine the language that it's written in. - * + * Represents a vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - detectLanguage(): void; + vertical = "Vertical", /** - * Expands the selection. - * + * Represents a cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param unit Optional. The unit to expand. - * @returns The number of characters added to the range or selection. */ - expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + cross = "Cross", /** - * Expands the selection. - * + * Represents a downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param unit Optional. The unit to expand. - * @returns The number of characters added to the range or selection. */ - expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + downwardDiagonal = "DownwardDiagonal", /** - * Expands the selection to include the entire story. - * + * Represents an upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expandToWholeStory(): void; + upwardDiagonal = "UpwardDiagonal", /** - * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. - * + * Represents a diagonal cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ - extend(character?: Word.OperationUnit): void; + diagonalCross = "DiagonalCross", + } + /** + * Indicates the effects camera type used by the specified object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetCamera { /** - * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. - * + * Represents a mixed camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. */ - extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + mixed = "Mixed", /** - * Returns a `Range` object that represents the next unit relative to the selection. - * + * Represents a legacy oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for the `next` operation. - * @returns A `Range` object that represents the next unit relative to the selection. */ - getNextRange(options?: Word.SelectionNextOptions): Word.Range; + legacyObliqueTopLeft = "LegacyObliqueTopLeft", /** - * Returns a `Range` object that represents the previous unit relative to the selection. - * + * Represents a legacy oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for the `previous` operation. - * @returns A `Range` object that represents the previous unit relative to the selection. */ - getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + legacyObliqueTop = "LegacyObliqueTop", /** - * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. - * + * Represents a legacy oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for the `goTo` operation. - * @returns A `Range` object that is now selected. */ - goTo(options?: Word.SelectionGoToOptions): Word.Range; + legacyObliqueTopRight = "LegacyObliqueTopRight", /** - * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a legacy oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what The item type to go to. - * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. */ - goToNext(what: Word.GoToItem): Word.Range; + legacyObliqueLeft = "LegacyObliqueLeft", /** - * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a legacy oblique front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what The item type to go to. - * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. */ - goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + legacyObliqueFront = "LegacyObliqueFront", /** - * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a legacy oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what The item type to go to. - * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. */ - goToPrevious(what: Word.GoToItem): Word.Range; + legacyObliqueRight = "LegacyObliqueRight", /** - * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. - * + * Represents a legacy oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param what The item type to go to. - * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. */ - goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", /** - * Inserts the specified text at the end of the range or selection. - * + * Represents a legacy oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param text Text to insert. */ - insertAfter(text: string): void; + legacyObliqueBottom = "LegacyObliqueBottom", /** - * Inserts the specified text before the selection. - * + * Represents a legacy oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param text Text to insert. */ - insertBefore(text: string): void; + legacyObliqueBottomRight = "LegacyObliqueBottomRight", /** - * Adds cells to an existing table. - * + * Represents a legacy perspective top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ - insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", /** - * Adds cells to an existing table. - * + * Represents a legacy perspective top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. */ - insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + legacyPerspectiveTop = "LegacyPerspectiveTop", /** - * Inserts columns to the left of the column that contains the selection. - * + * Represents a legacy perspective top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertColumnsLeft(): void; + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", /** - * Inserts columns to the right of the current selection. - * + * Represents a legacy perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertColumnsRight(): void; + legacyPerspectiveLeft = "LegacyPerspectiveLeft", /** - * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. - * + * Represents a legacy perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Options for inserting the date or time. */ - insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + legacyPerspectiveFront = "LegacyPerspectiveFront", /** - * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. - * + * Represents a legacy perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for inserting the formula. */ - insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + legacyPerspectiveRight = "LegacyPerspectiveRight", /** - * Inserts a new page at the position of the insertion point. - * + * Represents a legacy perspective bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertNewPage(): void; + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", /** - * Inserts a paragraph mark after the selection. - * + * Represents a legacy perspective bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphAfter(): void; + legacyPerspectiveBottom = "LegacyPerspectiveBottom", /** - * Inserts a new paragraph before the selection or range. - * + * Represents a legacy perspective bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphBefore(): void; + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", /** - * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. - * + * Represents an orthographic front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertParagraphStyleSeparator(): void; + orthographicFront = "OrthographicFront", /** - * Inserts rows above the current selection. - * + * Represents an isometric top-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numRows Optional. Number of rows to insert. */ - insertRowsAbove(numRows: number): void; + isometricTopUp = "IsometricTopUp", /** - * Inserts rows below the current selection. - * + * Represents an isometric top-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numRows Optional. Number of rows to insert. */ - insertRowsBelow(numRows: number): void; + isometricTopDown = "IsometricTopDown", /** - * Inserts a symbol in place of the specified selection. - * + * Represents an isometric bottom-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characterNumber The character number of the symbol. - * @param options Optional. Options for inserting the symbol. */ - insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + isometricBottomUp = "IsometricBottomUp", /** - * Inserts the specified text. - * + * Represents an isometric bottom-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param Text The text to insert. */ - insertText(Text: string): void; + isometricBottomDown = "IsometricBottomDown", /** - * Inserts the specified XML into the document at the cursor, replacing any selected text. - * + * Represents an isometric left-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param xml The XML string to insert. - * @param transform Optional. XSL transform to apply. */ - insertXML(xml: string, transform?: string): void; + isometricLeftUp = "IsometricLeftUp", /** - * Returns whether the selection is equal to the specified range. - * + * Represents an isometric left-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range to compare. - * @returns `true` if the selection is equal to the specified range. */ - isEqual(range: Word.Range): OfficeExtension.ClientResult; + isometricLeftDown = "IsometricLeftDown", /** - * Returns `true` if the selection is contained within the specified range. - * + * Represents an isometric right-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range to compare. - * @returns `true` if the selection is contained within the specified range. */ - isInRange(range: Word.Range): OfficeExtension.ClientResult; + isometricRightUp = "IsometricRightUp", /** - * Returns whether the selection is in the same story as the specified range. - * + * Represents an isometric right-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range to compare. - * @returns `true` if the selection is in the same story as the specified range. */ - isInStory(range: Word.Range): OfficeExtension.ClientResult; + isometricRightDown = "IsometricRightDown", /** - * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. - * + * Represents an isometric off-axis 1 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving the selection. - * @returns The number of characters by which the selection was moved. */ - move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + isometricOffAxis1Left = "IsometricOffAxis1Left", /** - * Moves the selection down. - * + * Represents an isometric off-axis 1 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving down. - * @returns The number of characters by which the selection was moved. */ - moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + isometricOffAxis1Right = "IsometricOffAxis1Right", /** - * Moves the ending character position of the range or selection. - * + * Represents an isometric off-axis 1 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving end. - * @returns The number of characters by which the selection was moved. */ - moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + isometricOffAxis1Top = "IsometricOffAxis1Top", /** - * Moves the end position of the selection until any of the specified characters are found in the document. - * + * Represents an isometric off-axis 2 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + isometricOffAxis2Left = "IsometricOffAxis2Left", /** - * Moves the ending character position of the selection while any of the specified characters are found in the document. - * + * Represents an isometric off-axis 2 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + isometricOffAxis2Right = "IsometricOffAxis2Right", /** - * Moves the selection to the left. - * + * Represents an isometric off-axis 2 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving left. - * @returns The number of characters by which the selection was moved. */ - moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + isometricOffAxis2Top = "IsometricOffAxis2Top", /** - * Moves the selection to the right. - * + * Represents an isometric off-axis 3 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving right. - * @returns The number of characters by which the selection was moved. */ - moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + isometricOffAxis3Left = "IsometricOffAxis3Left", /** - * Moves the start position of the selection. - * + * Represents an isometric off-axis 3 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for the `moveStart` operation. - * @returns The number of characters by which the selection was moved. */ - moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + isometricOffAxis3Right = "IsometricOffAxis3Right", /** - * Moves the start position of the selection until one of the specified characters is found in the document. - * + * Represents an isometric off-axis 3 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", /** - * Moves the start position of the selection while any of the specified characters are found in the document. - * + * Represents an isometric off-axis 4 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + isometricOffAxis4Left = "IsometricOffAxis4Left", /** - * Moves the selection until one of the specified characters is found in the document. - * + * Represents an isometric off-axis 4 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + isometricOffAxis4Right = "IsometricOffAxis4Right", /** - * Moves the selection up. - * + * Represents an isometric off-axis 4 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for moving up. - * @returns The number of characters by which the selection was moved. */ - moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", /** - * Moves the selection while any of the specified characters are found in the document. - * + * Represents an oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param characters Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. - * @param count Optional. Maximum number of characters to search. - * @returns The number of characters by which the selection was moved. */ - moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + obliqueTopLeft = "ObliqueTopLeft", /** - * Selects the next field. - * + * Represents an oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The next field. */ - nextField(): Word.Field; + obliqueTop = "ObliqueTop", /** - * Moves the selection to the next subDocument. - * + * Represents an oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSubdocument(): void; + obliqueTopRight = "ObliqueTopRight", /** - * Pastes the content from clipboard and formats them as specified. - * + * Represents an oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type The format paste type for table cells */ - pasteAndFormat(type: Word.PasteFormatType): void; + obliqueLeft = "ObliqueLeft", /** - * Pastes the content from clipboard and formats them as specified. - * + * Represents an oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type The format paste type for table cells */ - pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + obliqueRight = "ObliqueRight", /** - * Pastes and formats a Microsoft Excel table. - * + * Represents an oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param linkedToExcel Whether the table is linked to Excel. - * @param wordFormatting Whether to apply Word formatting. - * @param rtf Whether to paste as Rich Text Format (RTF). */ - pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + obliqueBottomLeft = "ObliqueBottomLeft", /** - * Applies formatting copied with the `copyFormat` method to the selection. - * + * Represents an oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteFormat(): void; + obliqueBottom = "ObliqueBottom", /** - * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. - * + * Represents an oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteTableCellsAppendTable(): void; + obliqueBottomRight = "ObliqueBottomRight", /** - * Pastes a cell or group of cells as a nested table into the selection. - * + * Represents a perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteTableCellsAsNestedTable(): void; + perspectiveFront = "PerspectiveFront", /** - * Selects and returns the previous field. - * + * Represents a perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * @returns The previous field. */ - previousField(): Word.Field; + perspectiveLeft = "PerspectiveLeft", /** - * Moves the selection to the previous subDocument. - * + * Represents a perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSubdocument(): void; + perspectiveRight = "PerspectiveRight", /** - * Replaces the selection with a new paragraph. - * + * Represents a perspective above camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replaceParagraph(): void; + perspectiveAbove = "PerspectiveAbove", /** - * Selects the current text. - * + * Represents a perspective below camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + perspectiveBelow = "PerspectiveBelow", /** - * Selects the entire cell containing the current selection when the selection is in a table. - * + * Represents a perspective above-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCell(): void; + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", /** - * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. - * + * Represents a perspective above-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectColumn(): void; + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", /** - * Extends the selection forward until text with a different paragraph alignment is encountered. - * + * Represents a perspective contrasting-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentAlignment(): void; + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", /** - * Extends the selection forward until text with a different color is encountered. - * + * Represents a perspective contrasting-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentColor(): void; + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", /** - * Extends the selection forward until text in a different font or font size is encountered. - * + * Represents a perspective heroic-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentFont(): void; + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", /** - * Extends the selection forward until text with different left or right paragraph indents is encountered. - * + * Represents a perspective heroic-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentIndent(): void; + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", /** - * Extends the selection forward until a paragraph with different line spacing is encountered. - * + * Represents a perspective heroic-extreme left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentSpacing(): void; + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", /** - * Extends the selection forward until a paragraph with different tab stops is encountered. - * + * Represents a perspective heroic-extreme right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectCurrentTabs(): void; + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", /** - * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. - * + * Represents a relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selectRow(): void; + perspectiveRelaxed = "PerspectiveRelaxed", /** - * Sets the starting and ending character positions for the selection. - Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. - * + * Represents a moderately relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param start The starting character position of the current story. - * @param end The ending character position of the current story. */ - setRange(start: number, end: number): void; + perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + } + /** + * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetExtrusionDirection { /** - * Shrinks the selection to the next smaller unit of text. - The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. - * + * Represents a mixed extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shrink(): void; + mixed = "Mixed", /** - * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. - * + * Represents an extrusion direction to the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shrinkDiscontiguousSelection(): void; + bottomRight = "BottomRight", /** - * Inserts an empty paragraph above the first row in the selection. - If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. - * + * Represents an extrusion direction to the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitTable(): void; + bottom = "Bottom", /** - * Switches the selection between a Unicode character and its corresponding hexadecimal value. - * + * Represents an extrusion direction to the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggleCharacterCode(): void; + bottomLeft = "BottomLeft", /** - * Deletes the character preceding the selection (if collapsed) or the insertion point. - * + * Represents an extrusion direction to the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - typeBackspace(): 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.SelectionLoadOptions): Word.Selection; + right = "Right", /** - * 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. + * Represents no extrusion direction. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Selection; + none = "None", /** - * 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. + * Represents an extrusion direction to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Selection; + left = "Left", /** - * 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. + * Represents an extrusion direction to the top-right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Selection; + topRight = "TopRight", /** - * 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. + * Represents an extrusion direction to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Selection; + top = "Top", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + * Represents an extrusion direction to the top-left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SelectionData; + topLeft = "TopLeft", } /** - * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * Specifies which predefined gradient to use to fill a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class RangeScopedCollection 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.Range[]; + enum PresetGradientType { /** - * Gets a `Range` object by its index in the collection. - * + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The location of a `Range` object in the collection. - */ - getItem(index: number): Word.Range; - /** - * 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.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; - /** - * 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.RangeScopedCollection; + mixed = "Mixed", /** - * 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. + * A warm gradient resembling an early sunset. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RangeScopedCollection; + earlySunset = "EarlySunset", /** - * 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. + * A deeper, richer gradient resembling a late sunset. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.RangeScopedCollection; + lateSunset = "LateSunset", /** - * 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. + * A dark gradient evoking the colors of nightfall. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.RangeScopedCollection; + nightfall = "Nightfall", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * A light gradient representing the colors of daybreak. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.RangeScopedCollectionData; - } - /** - * Specifies the direction in which text flows from one text column to the next. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FlowDirection { + daybreak = "Daybreak", /** - * Text flows from left to right. + * A gradient that mimics the colors of the horizon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + horizon = "Horizon", /** - * Text flows from right to left. + * A warm, sandy gradient inspired by desert tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", - } - /** - * Specifies where the gutter appears in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterPosition { + desert = "Desert", /** - * The gutter appears on the left side of the document. + * A cool gradient reflecting ocean hues. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + ocean = "Ocean", /** - * The gutter appears on the right side of the document. + * A soft, tranquil gradient resembling calm water. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + calmWater = "CalmWater", /** - * The gutter appears at the top of the document. + * A vivid gradient with fiery tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", - } - /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterStyle { + fire = "Fire", /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * A muted gradient with fog-like softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + fog = "Fog", /** - * Gutter style for Latin text flow. This is mainly left to right. + * A natural green gradient inspired by moss. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies how text is laid out in the layout mode for the current document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LayoutMode { + moss = "Moss", /** - * Default layout mode. + * A vibrant gradient with peacock feather colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + peacock = "Peacock", /** - * Grid layout mode. + * A light, golden gradient resembling wheat. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid = "Grid", + wheat = "Wheat", /** - * Line grid layout mode. + * A warm, aged paper-like gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineGrid = "LineGrid", + parchment = "Parchment", /** - * Genko layout mode. + * A rich, reddish-brown gradient like mahogany wood. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - genko = "Genko", - } - /** - * Specifies the numbering rule to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberingRule { + mahogany = "Mahogany", /** - * Restart numbering continuously. + * A colorful gradient resembling a rainbow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartContinuous = "RestartContinuous", + rainbow = "Rainbow", /** - * Restart numbering at the beginning of each section. + * A variation of the rainbow gradient with different color emphasis. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartSection = "RestartSection", + rainbowII = "RainbowII", /** - * Restart numbering at the beginning of each page. + * A shiny, metallic gold gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartPage = "RestartPage", - } - /** - * Specifies a page layout orientation. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageOrientation { + gold = "Gold", /** - * Portrait orientation. + * A variation of the gold gradient with different tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portrait = "Portrait", + goldII = "GoldII", /** - * Landscape orientation. + * A metallic gradient resembling brass. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - landscape = "Landscape", - } - /** - * Specifies the type of vertical alignment to apply. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageSetupVerticalAlignment { + brass = "Brass", /** - * Align text to the top. + * A sleek, reflective chrome gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + chrome = "Chrome", /** - * Align text to the center. + * A variation of the chrome gradient with alternate highlights. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + chromeII = "ChromeII", /** - * Justify text vertically. + * A smooth, metallic silver gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justify = "Justify", + silver = "Silver", /** - * Align text to the bottom. + * A deep blue gradient inspired by sapphire. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + sapphire = "Sapphire", } /** - * Specifies a paper size. + * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PaperSize { + enum PresetLightingDirection { /** - * 10x14 paper size. + * Represents a mixed lighting direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size10x14 = "Size10x14", + mixed = "Mixed", /** - * 11x17 paper size. + * Represents lighting from the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size11x17 = "Size11x17", + topLeft = "TopLeft", /** - * Letter paper size. + * Represents lighting from the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + top = "Top", /** - * Small letter paper size. + * Represents lighting from the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterSmall = "LetterSmall", + topRight = "TopRight", /** - * Legal paper size. + * Represents lighting from the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legal = "Legal", + left = "Left", /** - * Executive paper size. + * Represents no lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - executive = "Executive", + none = "None", /** - * A3 paper size. + * Represents lighting from the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a3 = "A3", + right = "Right", /** - * A4 paper size. + * Represents lighting from the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4 = "A4", + bottomLeft = "BottomLeft", /** - * Small A4 paper size. + * Represents lighting from the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4Small = "A4Small", + bottom = "Bottom", /** - * A5 paper size. + * Represents lighting from the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a5 = "A5", + bottomRight = "BottomRight", + } + /** + * Specifies the intensity of light used on a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetLightingSoftness { /** - * B4 paper size. + * Represents a mixed lighting softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b4 = "B4", + mixed = "Mixed", /** - * B5 paper size. + * Represents dim lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b5 = "B5", + dim = "Dim", /** - * C-sheet paper size. + * Represents normal lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - csheet = "CSheet", + normal = "Normal", /** - * D-sheet paper size. + * Represents bright lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dsheet = "DSheet", + bright = "Bright", + } + /** + * Specifies the extrusion surface material. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetMaterial { /** - * E-sheet paper size. + * Represents a mixed material type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - esheet = "ESheet", + mixed = "Mixed", /** - * Fanfold legal German paper size. + * Represents a matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldLegalGerman = "FanfoldLegalGerman", + matte = "Matte", /** - * Fanfold standard German paper size. + * Represents a plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldStdGerman = "FanfoldStdGerman", + plastic = "Plastic", /** - * Fanfold US paper size. + * Represents a metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldUS = "FanfoldUS", + metal = "Metal", /** - * Folio paper size. + * Represents a wireframe material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - folio = "Folio", + wireFrame = "WireFrame", /** - * Ledger paper size. + * Represents a second matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ledger = "Ledger", + matte2 = "Matte2", /** - * Note paper size. + * Represents a second plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - note = "Note", + plastic2 = "Plastic2", /** - * Quarto paper size. + * Represents a second metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quarto = "Quarto", + metal2 = "Metal2", /** - * Statement paper size. + * Represents a warm matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - statement = "Statement", + warmMatte = "WarmMatte", /** - * Tabloid paper size. + * Represents a translucent powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabloid = "Tabloid", + translucentPowder = "TranslucentPowder", /** - * Envelope size 9. + * Represents a powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope9 = "Envelope9", + powder = "Powder", /** - * Envelope size 10. + * Represents a dark edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope10 = "Envelope10", + darkEdge = "DarkEdge", /** - * Envelope size 11. + * Represents a soft edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope11 = "Envelope11", + softEdge = "SoftEdge", /** - * Envelope size 12. + * Represents a clear material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope12 = "Envelope12", + clear = "Clear", /** - * Envelope size 14. + * Represents a flat material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope14 = "Envelope14", + flat = "Flat", /** - * Envelope B4 size. + * Represents a soft metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB4 = "EnvelopeB4", + softMetal = "SoftMetal", + } + /** + * Specifies texture to be used to fill a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetTexture { /** - * Envelope B5 size. + * Represents a mixed texture type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB5 = "EnvelopeB5", + mixed = "Mixed", /** - * Envelope B6 size. + * Represents a papyrus texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB6 = "EnvelopeB6", + papyrus = "Papyrus", /** - * Envelope C3 size. + * Represents a canvas texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC3 = "EnvelopeC3", + canvas = "Canvas", /** - * Envelope C4 size. + * Represents a denim texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC4 = "EnvelopeC4", + denim = "Denim", /** - * Envelope C5 size. + * Represents a woven mat texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC5 = "EnvelopeC5", + wovenMat = "WovenMat", /** - * Envelope C6 size. + * Represents a water droplets texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC6 = "EnvelopeC6", + waterDroplets = "WaterDroplets", /** - * Envelope C65 size. + * Represents a paper bag texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC65 = "EnvelopeC65", + paperBag = "PaperBag", /** - * Envelope DL size. + * Represents a fish fossil texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeDL = "EnvelopeDL", + fishFossil = "FishFossil", /** - * Envelope Italy size. + * Represents a sand texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeItaly = "EnvelopeItaly", + sand = "Sand", /** - * Envelope Monarch size. + * Represents a green marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeMonarch = "EnvelopeMonarch", + greenMarble = "GreenMarble", /** - * Envelope Personal size. + * Represents a white marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopePersonal = "EnvelopePersonal", + whiteMarble = "WhiteMarble", /** - * Custom paper size. + * Represents a brown marble texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies how Word displays the reading order and alignment for the specified sections. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SectionDirection { + brownMarble = "BrownMarble", /** - * Right-to-left reading order. + * Represents a granite texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + granite = "Granite", /** - * Left-to-right reading order. + * Represents a newsprint texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", - } - /** - * Specifies the type of section break for the specified item. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SectionStart { + newsprint = "Newsprint", /** - * Continuous section break. + * Represents a recycled paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuous = "Continuous", + recycledPaper = "RecycledPaper", /** - * New column section break. + * Represents a parchment texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newColumn = "NewColumn", + parchment = "Parchment", /** - * New page section break. + * Represents a stationery texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newPage = "NewPage", + stationery = "Stationery", /** - * Even page section break. + * Represents a blue tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPage = "EvenPage", + blueTissuePaper = "BlueTissuePaper", /** - * Odd page section break. + * Represents a pink tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddPage = "OddPage", - } - /** - * Specifies how a table is resized to fit its contents or the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum AutoFitBehavior { + pinkTissuePaper = "PinkTissuePaper", /** - * Disables automatic resizing. The table retains its current size. + * Represents a purple mesh texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fixedSize = "FixedSize", + purpleMesh = "PurpleMesh", /** - * Automatically resizes the table columns to fit the contents. + * Represents a bouquet texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - content = "Content", + bouquet = "Bouquet", /** - * Automatically resizes the table to fit the window width. + * Represents a cork texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - window = "Window", - } - /** - * Specifies the type of bidirectional calendar to use. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CalendarTypeBidirectional { + cork = "Cork", /** - * Uses the Gregorian calendar. + * Represents a walnut texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gregorian = "Gregorian", + walnut = "Walnut", /** - * Uses the Bidirectional calendar. + * Represents an oak texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + oak = "Oak", + /** + * Represents a medium wood texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mediumWood = "MediumWood", } /** - * Specifies the type of caption label to use. + * Specifies an extrusion (three-dimensional) format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CaptionLabelType { - /** - * Specifies a figure caption label. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - figure = "Figure", + enum PresetThreeDimensionalFormat { /** - * Specifies a table caption label. + * Represents a mixed three-dimensional format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + mixed = "Mixed", /** - * Specifies an equation caption label. + * Represents three-dimensional format 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equation = "Equation", - } - /** - * Specifies the position of a caption relative to the object it describes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CaptionPosition { + format1 = "Format1", /** - * Places the caption above the selected item. + * Represents three-dimensional format 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - above = "Above", + format2 = "Format2", /** - * Places the caption below the selected item. + * Represents three-dimensional format 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - below = "Below", - } - /** - * Specifies the direction in which to collapse a selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CollapseDirection { + format3 = "Format3", /** - * Collapses the selection to the start position. + * Represents three-dimensional format 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start = "Start", + format4 = "Format4", /** - * Collapses the selection to the end position. + * Represents three-dimensional format 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end = "End", - } - /** - * Specifies the language to use for date formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DateLanguage { + format5 = "Format5", /** - * Uses the bidirectional date/time format. + * Represents three-dimensional format 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + format6 = "Format6", /** - * Uses the latin date/time format. + * Represents three-dimensional format 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies the default behavior when inserting a new table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DefaultTableBehavior { + format7 = "Format7", /** - * Disables AutoFit. + * Represents three-dimensional format 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableAutoFit = "DisableAutoFit", + format8 = "Format8", /** - * Enables AutoFit. + * Represents three-dimensional format 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enableAutoFit = "EnableAutoFit", - } - /** - * Specifies the location of endnotes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum EndnoteLocation { + format9 = "Format9", /** - * Places endnotes at the end of the section. + * Represents three-dimensional format 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endOfSection = "EndOfSection", + format10 = "Format10", /** - * Places endnotes at the end of the document. + * Represents three-dimensional format 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endOfDocument = "EndOfDocument", - } - /** - * Specifies the font bias to use when formatting East Asian text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FontBias { + format11 = "Format11", /** - * Uses the default font bias. + * Represents three-dimensional format 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + format12 = "Format12", /** - * Uses the font bias for Far East text. + * Represents three-dimensional format 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast = "FarEast", + format13 = "Format13", /** - * No font bias specified. + * Represents three-dimensional format 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpecified = "NoSpecified", - } - /** - * Specifies the location of footnotes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FootnoteLocation { + format14 = "Format14", /** - * Places footnotes at the bottom of the page. + * Represents three-dimensional format 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomOfPage = "BottomOfPage", + format15 = "Format15", /** - * Places footnotes below the text on the page. + * Represents three-dimensional format 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beneathText = "BeneathText", - } - /** - * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GoToDirection { + format16 = "Format16", /** - * Moves to the first item. + * Represents three-dimensional format 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - first = "First", + format17 = "Format17", /** - * Moves to the last item. + * Represents three-dimensional format 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - last = "Last", + format18 = "Format18", /** - * Moves to the next item. + * Represents three-dimensional format 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + format19 = "Format19", /** - * Moves to the previous item. + * Represents three-dimensional format 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous = "Previous", + format20 = "Format20", } /** - * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * Specifies the type of the {@link Word.ReflectionFormat} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum GoToItem { - /** - * Moves to a bookmark. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bookmark = "Bookmark", - /** - * Moves to a comment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - comment = "Comment", - /** - * Moves to a endnote. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endnote = "Endnote", + enum ReflectionType { /** - * Moves to a field. + * Represents a mixed reflection type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - field = "Field", + mixed = "Mixed", /** - * Moves to a footnote. + * Represents no reflection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnote = "Footnote", + none = "None", /** - * Moves to a graphic. + * Represents reflection type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - graphic = "Graphic", + type1 = "Type1", /** - * Moves to a heading. + * Represents reflection type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heading = "Heading", + type2 = "Type2", /** - * Moves to a line. + * Represents reflection type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line = "Line", + type3 = "Type3", /** - * Moves to a page. + * Represents reflection type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - page = "Page", + type4 = "Type4", /** - * Moves to a section. + * Represents reflection type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - section = "Section", + type5 = "Type5", /** - * Moves to a table. + * Represents reflection type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + type6 = "Type6", /** - * Moves to an embedded object. + * Represents reflection type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - embeddedObject = "EmbeddedObject", + type7 = "Type7", /** - * Moves to an equation. + * Represents reflection type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equation = "Equation", + type8 = "Type8", /** - * Moves to a percent. + * Represents reflection type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + type9 = "Type9", + } + /** + * Specifies the type of shadowing effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShadowStyle { /** - * Moves to a spelling error. + * Represents a mixed shadow style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingError = "SpellingError", + mixed = "Mixed", /** - * Moves to a grammatical error. + * Represents an outer shadow style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammaticalError = "GrammaticalError", + outerShadow = "OuterShadow", /** - * Moves to a proofreading error. + * Represents an inner shadow style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proofreadingError = "ProofreadingError", + innerShadow = "InnerShadow", } /** - * Specifies the type of movement when navigating through a document. + * Specifies the type of shadow displayed with a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum MovementType { + enum ShadowType { /** - * Moves the insertion point or selection. + * Represents a mixed shadow type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - move = "Move", + mixed = "Mixed", /** - * Extends the selection. + * Represents shadow type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extend = "Extend", - } - /** - * Specifies the numbering style to use for footnotes or endnotes. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NoteNumberStyle { + type1 = "Type1", /** - * Uses Arabic numerals (1, 2, 3...). + * Represents shadow type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + type2 = "Type2", /** - * Uses uppercase Roman numerals (I, II, III...). + * Represents shadow type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uppercaseRoman = "UppercaseRoman", + type3 = "Type3", /** - * Uses lowercase Roman numerals (i, ii, iii...). + * Represents shadow type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowercaseRoman = "LowercaseRoman", + type4 = "Type4", /** - * Uses uppercase letters (A, B, C...). + * Represents shadow type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uppercaseLetter = "UppercaseLetter", + type5 = "Type5", /** - * Uses lowercase letters (a, b, c...). + * Represents shadow type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowercaseLetter = "LowercaseLetter", + type6 = "Type6", /** - * Uses a symbol instead of a number. + * Represents shadow type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - symbol = "Symbol", + type7 = "Type7", /** - * Uses full-width Arabic numerals. + * Represents shadow type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicFullWidth = "ArabicFullWidth", + type8 = "Type8", /** - * Uses Kanji characters. + * Represents shadow type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanji = "Kanji", + type9 = "Type9", /** - * Uses Kanji digits. + * Represents shadow type 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanjiDigit = "KanjiDigit", + type10 = "Type10", /** - * Uses traditional Kanji characters. + * Represents shadow type 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanjiTraditional = "KanjiTraditional", + type11 = "Type11", /** - * Uses numbers enclosed in circles. + * Represents shadow type 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberInCircle = "NumberInCircle", + type12 = "Type12", /** - * Uses Hanja characters with phonetic reading. + * Represents shadow type 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hanjaRead = "HanjaRead", + type13 = "Type13", /** - * Uses Hanja digits with phonetic reading. + * Represents shadow type 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hanjaReadDigit = "HanjaReadDigit", + type14 = "Type14", /** - * Uses traditional Chinese numerals (style 1). + * Represents shadow type 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChineseNumeral1 = "traditionalChineseNumeral1", + type15 = "Type15", /** - * Uses traditional Chinese numerals (style 2). + * Represents shadow type 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChineseNumeral2 = "traditionalChineseNumeral2", + type16 = "Type16", /** - * Uses simplified Chinese numerals (style 1). + * Represents shadow type 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + type17 = "Type17", /** - * Uses simplified Chinese numerals (style 2). + * Represents shadow type 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + type18 = "Type18", /** - * Uses Hebrew letters (style 1). + * Represents shadow type 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrewLetter1 = "HebrewLetter1", + type19 = "Type19", /** - * Uses Arabic letters (style 1). + * Represents shadow type 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLetter1 = "ArabicLetter1", + type20 = "Type20", /** - * Uses Hebrew letters (style 2). + * Represents shadow type 21. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrewLetter2 = "HebrewLetter2", + type21 = "Type21", /** - * Uses Arabic letters (style 2). + * Represents shadow type 22. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLetter2 = "ArabicLetter2", + type22 = "Type22", /** - * Uses Hindi letters (style 1). + * Represents shadow type 23. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiLetter1 = "HindiLetter1", + type23 = "Type23", /** - * Uses Hindi letters (style 2). + * Represents shadow type 24. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiLetter2 = "HindiLetter2", + type24 = "Type24", /** - * Uses Hindi Arabic numerals. + * Represents shadow type 25. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiArabic = "HindiArabic", + type25 = "Type25", /** - * Uses Hindi cardinal text. + * Represents shadow type 26. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindiCardinalText = "HindiCardinalText", + type26 = "Type26", /** - * Uses Thai letters. + * Represents shadow type 27. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiLetter = "ThaiLetter", + type27 = "Type27", /** - * Uses Thai Arabic numerals. + * Represents shadow type 28. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiArabic = "ThaiArabic", + type28 = "Type28", /** - * Uses Thai cardinal text. + * Represents shadow type 29. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thaiCardinalText = "ThaiCardinalText", + type29 = "Type29", /** - * Uses Vietnamese cardinal text. + * Represents shadow type 30. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vietnameseCardinalText = "vietnameseCardinalText", - } - /** - * Specifies the unit of measurement used in Word operations. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum OperationUnit { + type30 = "Type30", /** - * Specifies a character unit. + * Represents shadow type 31. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - character = "Character", + type31 = "Type31", /** - * Specifies a word unit. + * Represents shadow type 32. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word = "Word", + type32 = "Type32", /** - * Specifies a sentence unit. + * Represents shadow type 33. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sentence = "Sentence", + type33 = "Type33", /** - * Specifies a paragraph unit. + * Represents shadow type 34. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + type34 = "Type34", /** - * Specifies a line unit. + * Represents shadow type 35. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line = "Line", + type35 = "Type35", /** - * Specifies a story unit. + * Represents shadow type 36. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - story = "Story", + type36 = "Type36", /** - * Specifies a screen unit. + * Represents shadow type 37. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screen = "Screen", + type37 = "Type37", /** - * Specifies a section unit. + * Represents shadow type 38. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - section = "Section", + type38 = "Type38", /** - * Specifies a column unit. + * Represents shadow type 39. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - column = "Column", + type39 = "Type39", /** - * Specifies a row unit. + * Represents shadow type 40. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + type40 = "Type40", /** - * Specifies a window unit. + * Represents shadow type 41. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - window = "Window", - /** - * Specifies a cell unit. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cell = "Cell", - /** - * Specifies a character format unit. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - characterFormat = "CharacterFormat", - /** - * Specifies a paragraph format unit. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - paragraphFormat = "ParagraphFormat", + type41 = "Type41", /** - * Specifies a table unit. + * Represents shadow type 42. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - table = "Table", + type42 = "Type42", /** - * Specifies an item unit. + * Represents shadow type 43. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - item = "Item", + type43 = "Type43", } /** - * Specifies the format to use when pasting data. + * Specifies the stylistic set to apply to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PasteDataType { + enum StylisticSet { /** - * Pastes the data as an OLE object. + * Default stylistic set. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oleObject = "OleObject", + default = "Default", /** - * Pastes the data as rich text format (RTF). + * Stylistic set 01. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rtf = "Rtf", + set01 = "Set01", /** - * Pastes the data as plain text. + * Stylistic set 02. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "Text", + set02 = "Set02", /** - * Pastes the data as a metafile picture. + * Stylistic set 03. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metafilePicture = "MetafilePicture", + set03 = "Set03", /** - * Pastes the data as a bitmap. + * Stylistic set 04. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bitmap = "Bitmap", + set04 = "Set04", /** - * Pastes the data as a device-independent bitmap (DIB). + * Stylistic set 05. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - deviceIndependentBitmap = "DeviceIndependentBitmap", + set05 = "Set05", /** - * Pastes the data as a hyperlink. + * Stylistic set 06. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + set06 = "Set06", /** - * Pastes the data as a shape. + * Stylistic set 07. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + set07 = "Set07", /** - * Pastes the data as an enhanced metafile. + * Stylistic set 08. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enhancedMetafile = "EnhancedMetafile", + set08 = "Set08", /** - * Pastes the data as HTML. + * Stylistic set 09. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - html = "Html", - } - /** - * Specifies the type of formatting when paste to a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PasteFormatType { + set09 = "Set09", /** - * Uses the default paste behavior. + * Stylistic set 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pasteDefault = "PasteDefault", + set10 = "Set10", /** - * Pastes text into a single cell. + * Stylistic set 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleCellText = "SingleCellText", + set11 = "Set11", /** - * Pastes a table into a single cell. + * Stylistic set 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - singleCellTable = "SingleCellTable", + set12 = "Set12", /** - * Continues numbering from the previous list. + * Stylistic set 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listContinueNumbering = "ListContinueNumbering", + set13 = "Set13", /** - * Restarts numbering for the new list. + * Stylistic set 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listRestartNumbering = "ListRestartNumbering", + set14 = "Set14", /** - * Appends the pasted table to the existing table. + * Stylistic set 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableAppendTable = "TableAppendTable", + set15 = "Set15", /** - * Inserts the pasted table as new rows. + * Stylistic set 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableInsertAsRows = "TableInsertAsRows", + set16 = "Set16", /** - * Inserts the pasted table with its original formatting. + * Stylistic set 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOriginalFormatting = "TableOriginalFormatting", + set17 = "Set17", /** - * Pastes a chart as a picture. + * Stylistic set 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chartPicture = "ChartPicture", + set18 = "Set18", /** - * Pastes a chart as an editable chart. + * Stylistic set 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chart = "Chart", + set19 = "Set19", /** - * Pastes a chart with a link to the source data. + * Stylistic set 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chartLinked = "ChartLinked", + set20 = "Set20", + } + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextureAlignment { /** - * Applies the original formatting of the pasted content. + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatOriginalFormatting = "FormatOriginalFormatting", + mixed = "Mixed", /** - * Applies surrounding formatting with emphasis. + * Aligns the texture to the top-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + topLeft = "TopLeft", /** - * Pastes content as plain text. + * Aligns the texture to the top center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatPlainText = "FormatPlainText", + top = "Top", /** - * Overwrites existing cells with the pasted table. + * Aligns the texture to the top-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOverwriteCells = "TableOverwriteCells", + topRight = "TopRight", /** - * Combines the pasted list with an existing list. + * Aligns the texture to the middle left side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listCombineWithExistingList = "ListCombineWithExistingList", + left = "Left", /** - * Prevents merging the pasted list with an existing list. + * Aligns the texture to the center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listDontMerge = "ListDontMerge", + center = "Center", /** - * Uses the destination styles for the pasted content. + * Aligns the texture to the middle right side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - useDestinationStylesRecovery = "UseDestinationStylesRecovery", - } - /** - * Specifies the kind of reference to insert. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReferenceKind { + right = "Right", /** - * Inserts the full text of the referenced item. + * Aligns the texture to the bottom-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contentText = "ContentText", + bottomLeft = "BottomLeft", /** - * Inserts the number of the referenced item with relative context. + * Aligns the texture to the bottom center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberRelativeContext = "NumberRelativeContext", + bottom = "Bottom", /** - * Inserts only the number of the referenced item without context. + * Aligns the texture to the bottom-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberNoContext = "NumberNoContext", + bottomRight = "BottomRight", + } + /** + * Specifies the texture type for the selected fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextureType { /** - * Inserts the number of the referenced item with full context. + * Mixed texture type. Used when multiple shapes with different texture types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberFullContext = "NumberFullContext", + mixed = "Mixed", /** - * Inserts the entire caption of the referenced item. + * A predefined texture selected from the built-in texture gallery. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entireCaption = "EntireCaption", + preset = "Preset", /** - * Inserts only the label and number of the referenced item. + * A custom texture defined by the user, typically from an image file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onlyLabelAndNumber = "OnlyLabelAndNumber", + userDefined = "UserDefined", + } + /** + * Specifies the theme colors for document themes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ThemeColorIndex { /** - * Inserts only the caption text of the referenced item. + * Not a theme color. Used when the color is not part of the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onlyCaptionText = "OnlyCaptionText", + notThemeColor = "NotThemeColor", /** - * Inserts the footnote number of the referenced item. + * The first dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteNumber = "FootnoteNumber", + mainDark1 = "MainDark1", /** - * Inserts the endnote number of the referenced item. + * The first light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteNumber = "EndnoteNumber", + mainLight1 = "MainLight1", /** - * Inserts the page number of the referenced item. + * The second dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumber = "PageNumber", + mainDark2 = "MainDark2", /** - * Inserts the position of the referenced item. + * The second light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position = "Position", + mainLight2 = "MainLight2", /** - * Inserts the formatted footnote number of the referenced item. + * The first accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteNumberFormatted = "FootnoteNumberFormatted", + accent1 = "Accent1", /** - * Inserts the formatted endnote number of the referenced item. + * The second accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteNumberFormatted = "EndnoteNumberFormatted", - } - /** - * Specifies the type of reference to insert. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReferenceType { + accent2 = "Accent2", /** - * Refers to a numbered item in the document. + * The third accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberedItem = "NumberedItem", + accent3 = "Accent3", /** - * Refers to a heading in the document. + * The fourth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heading = "Heading", + accent4 = "Accent4", /** - * Refers to a bookmark in the document. + * The fifth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark = "Bookmark", + accent5 = "Accent5", /** - * Refers to a footnote in the document. + * The sixth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnote = "Footnote", + accent6 = "Accent6", /** - * Refers to an endnote in the document. + * The color used for hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnote = "Endnote", - } - /** - * Specifies the type of selection in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SelectionType { + hyperlink = "Hyperlink", /** - * No selection is made. + * The color used for followed hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSelection = "NoSelection", + hyperlinkFollowed = "HyperlinkFollowed", /** - * Represents an insertion point (IP) selection. + * The first background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertionPoint = "InsertionPoint", + background1 = "Background1", /** - * Represents a normal selection. + * The first text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + text1 = "Text1", /** - * Represents a frame selection. + * The second background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame = "Frame", + background2 = "Background2", /** - * Represents a column selection. + * The second text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - column = "Column", + text2 = "Text2", + } + /** + * Specifies the hyperlink type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HyperlinkType { /** - * Represents a row selection. + * Represents a hyperlink to a range in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + range = "Range", /** - * Represents a block selection. + * Represents a hyperlink to a shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - block = "Block", + shape = "Shape", /** - * Represents an inline shape selection. + * Represents a hyperlink to an inline shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ inlineShape = "InlineShape", - /** - * Represents a shape selection. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - selectionShape = "SelectionShape", } /** - * Specifies the type of field to sort by. + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SortFieldType { + class Bibliography 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; /** - * Sorts content alphanumerically. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphanumeric = "Alphanumeric", + readonly sources: Word.SourceCollection; /** - * Sorts content numerically. + * Specifies the name of the active style to use for the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numeric = "Numeric", + bibliographyStyle: string; /** - * Sorts content by date. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - date = "Date", + set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bibliography): void; /** - * Sorts content by syllables. + * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", + generateUniqueTag(): OfficeExtension.ClientResult; /** - * Sorts content using the Japanese JIS standard. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - japanJis = "JapanJis", + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; /** - * Sorts content by stroke count. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - stroke = "Stroke", + load(propertyNames?: string | string[]): Word.Bibliography; /** - * Sorts content using the Korean KS standard. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - koreaKs = "KoreaKs", - } - /** - * Specifies the sort order. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SortOrder { + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bibliography; /** - * Sorts in ascending order. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - ascending = "Ascending", + track(): Word.Bibliography; /** - * Sorts in descending order. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - descending = "Descending", + untrack(): Word.Bibliography; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BibliographyData; } /** - * Specifies where and what type of cells to add to an existing table. + * Represents a collection of {@link Word.Source} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableCellInsertionLocation { + class SourceCollection 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.Source[]; /** - * Inserts new cells to the left of the selected cells. + * Adds a new `Source` object to the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xml A string containing the XML data for the source. + * @returns A `Source` object that was added to the collection. */ - shiftRight = "ShiftRight", + add(xml: string): Word.Source; /** - * Inserts new cells above the selected cells. + * Gets a `Source` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a `Source` object. */ - shiftDown = "ShiftDown", + getItem(index: number): Word.Source; /** - * Inserts an entire row above the row that contains the selection. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - shiftRowDown = "ShiftRowDown", + load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; /** - * Inserts an entire column to the left of the column that contains the selection. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - shiftColumnRight = "ShiftColumnRight", + load(propertyNames?: string | string[]): Word.SourceCollection; + /** + * 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.SourceCollection; + /** + * 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.SourceCollection; + /** + * 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.SourceCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SourceCollectionData; } /** - * Specifies the predefined table formatting options. + * Represents an individual source, such as a book, journal article, or interview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableFormat { + class Source 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; /** - * No table format is applied. + * Gets if the `Source` object has been cited in the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly isCited: boolean; /** - * Applies the simple 1 table format. + * Gets the tag of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple1 = "Simple1", + readonly tag: string; /** - * Applies the simple 2 table format. + * Gets the XML representation of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple2 = "Simple2", + readonly xml: string; /** - * Applies the simple 3 table format. + * Deletes the `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple3 = "Simple3", + delete(): void; /** - * Applies the classic 1 table format. + * Returns the value of a field in the bibliography `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param name The name of the field to retrieve. */ - classic1 = "Classic1", + getFieldByName(name: string): OfficeExtension.ClientResult; /** - * Applies the classic 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - classic2 = "Classic2", + load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; /** - * Applies the classic 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - classic3 = "Classic3", + load(propertyNames?: string | string[]): Word.Source; /** - * Applies the classic 4 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - classic4 = "Classic4", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Source; /** - * Applies the colorful 1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - colorful1 = "Colorful1", + track(): Word.Source; /** - * Applies the colorful 2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - colorful2 = "Colorful2", + untrack(): Word.Source; /** - * Applies the colorful 3 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. */ - colorful3 = "Colorful3", + toJSON(): Word.Interfaces.SourceData; + } + /** + * Represents the page setup settings for a Word document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class PageSetup 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; /** - * Applies the columns 1 table format. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns1 = "Columns1", + lineNumbering: Word.LineNumbering; /** - * Applies the columns 2 table format. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns2 = "Columns2", + readonly textColumns: Word.TextColumnCollection; /** - * Applies the columns 3 table format. + * Specifies whether Microsoft Word prints the document as a booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns3 = "Columns3", + bookFoldPrinting: boolean; /** - * Applies the columns 4 table format. + * Specifies the number of pages for each booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns4 = "Columns4", + bookFoldPrintingSheets: number; /** - * Applies the columns 5 table format. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns5 = "Columns5", + bookFoldReversePrinting: boolean; /** - * Applies the grid 1 table format. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid1 = "Grid1", + bottomMargin: number; /** - * Applies the grid 2 table format. + * Specifies the number of characters per line in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid2 = "Grid2", + charsLine: number; /** - * Applies the grid 3 table format. + * Specifies whether the first page has a different header and footer. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid3 = "Grid3", + differentFirstPageHeaderFooter: boolean; /** - * Applies the grid 4 table format. + * Specifies the distance between the footer and the bottom of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid4 = "Grid4", + footerDistance: number; /** - * Applies the grid 5 table format. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid5 = "Grid5", + gutter: number; /** - * Applies the grid 6 table format. + * Specifies on which side the gutter appears in a document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid6 = "Grid6", + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Applies the grid 7 table format. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid7 = "Grid7", + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Applies the grid 8 table format. + * Specifies the distance between the header and the top of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid8 = "Grid8", + headerDistance: number; /** - * Applies the list 1 table format. + * Specifies the layout mode for the current document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list1 = "List1", + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Applies the list 2 table format. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list2 = "List2", + leftMargin: number; /** - * Applies the list 3 table format. + * Specifies the number of lines per page in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list3 = "List3", + linesPage: number; /** - * Applies the list 4 table format. + * Specifies if the inside and outside margins of facing pages are the same width. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list4 = "List4", + mirrorMargins: boolean; /** - * Applies the list 5 table format. + * Specifies whether odd and even pages have different headers and footers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list5 = "List5", + oddAndEvenPagesHeaderFooter: boolean; /** - * Applies the list 6 table format. + * Specifies the orientation of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list6 = "List6", + orientation: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Applies the list 7 table format. + * Specifies the page height in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list7 = "List7", + pageHeight: number; /** - * Applies the list 8 table format. + * Specifies the page width in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list8 = "List8", + pageWidth: number; /** - * Applies the 3D effects 1 table format. + * Specifies the paper size of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects1 = "ThreeDEffects1", + paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Applies the 3D effects 2 table format. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects2 = "ThreeDEffects2", + rightMargin: number; /** - * Applies the 3D effects 3 table format. + * Specifies the reading order and alignment for the specified sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects3 = "ThreeDEffects3", + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Applies the contemporary table format. + * Specifies the type of section break for the specified object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contemporary = "Contemporary", + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Applies the elegant table format. + * Specifies whether to show the grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - elegant = "Elegant", + showGrid: boolean; /** - * Applies the professional table format. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - professional = "Professional", + suppressEndnotes: boolean; /** - * Applies the subtle 1 table format. + * Specifies the top margin of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle1 = "Subtle1", + topMargin: number; /** - * Applies the subtle 2 table format. + * Specifies whether to print two pages per sheet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle2 = "Subtle2", + twoPagesOnOne: boolean; /** - * Applies the web 1 table format. + * Specifies the vertical alignment of text on each page in a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web1 = "Web1", + verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; /** - * Applies the web 2 table format. + * 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.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PageSetup): void; + /** + * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web2 = "Web2", + setAsTemplateDefault(): void; /** - * Applies the web 3 table format. + * Switches between portrait and landscape page orientations for a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web3 = "Web3", + togglePortrait(): 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.PageSetupLoadOptions): Word.PageSetup; + /** + * 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.PageSetup; + /** + * 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.PageSetup; + /** + * 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.PageSetup; + /** + * 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.PageSetup; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.PageSetupData; } /** - * Specifies the orientation of text in a text frame or shape. + * Represents line numbers in the left margin or to the left of each newspaper-style column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextOrientation { + class LineNumbering 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; /** - * Text is horizontal. + * Specifies the numeric increment for line numbers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + countBy: number; /** - * Text is vertical with letters rotated 90 degrees clockwise. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upward = "Upward", + distanceFromText: number; /** - * Text is vertical with letters rotated 90 degrees counterclockwise. + * Specifies if line numbering is active for the specified document, section, or sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downward = "Downward", + isActive: boolean; /** - * Text is vertical and reads downward from the top, right to left. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalFarEast = "VerticalFarEast", + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Text is horizontal but from right to left to accommodate right-to-left languages. + * Specifies the starting line number. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalRotatedFarEast = "HorizontalRotatedFarEast", + startingNumber: number; /** - * Text is vertical and reads downward from the top, left to right. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - vertical = "Vertical", + set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineNumbering): 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.LineNumberingLoadOptions): Word.LineNumbering; + /** + * 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.LineNumbering; + /** + * 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.LineNumbering; + /** + * 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.LineNumbering; + /** + * 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.LineNumbering; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineNumberingData; } /** - * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. - The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Bookmark extends OfficeExtension.ClientObject { + class TextColumnCollection 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.TextColumn[]; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * Returns a `TextColumn` object that represents a new text column added to a section or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly range: Word.Range; - /** - * Specifies the ending character position of the bookmark. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Optional. Options for configuring the new text column. + * @returns A `TextColumn` object that represents a new text column added to the document. */ - end: number; + add(options?: Word.TextColumnAddOptions): Word.TextColumn; /** - * Returns `true` if the bookmark is a table column. + * Gets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isColumn: boolean; + getFlowDirection(): OfficeExtension.ClientResult; /** - * Returns `true` if the bookmark is empty. + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isEmpty: boolean; + getHasLineBetween(): OfficeExtension.ClientResult; /** - * Returns the name of the `Bookmark` object. + * Gets whether text columns are evenly spaced. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + getIsEvenlySpaced(): OfficeExtension.ClientResult; /** - * Specifies the starting character position of the bookmark. + * Arranges text into the specified number of text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numColumns The number of columns the text is to be arranged into. */ - start: number; + setCount(numColumns: number): void; /** - * Returns the story type for the bookmark. + * Sets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value The flow direction to set. */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - /** - * 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.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bookmark): void; + setFlowDirection(value: Word.FlowDirection): void; /** - * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * Sets the direction in which text flows from one text column to the next. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param name The name of the new bookmark. + * @param value The flow direction to set. */ - copyTo(name: string): Word.Bookmark; + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; /** - * Deletes the bookmark. + * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value `true` to show vertical lines between columns. */ - delete(): void; + setHasLineBetween(value: boolean): void; /** - * Selects the bookmark. + * Sets whether text columns are evenly spaced. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value `true` to evenly space all the text columns in the document. */ - select(): void; + setIsEvenlySpaced(value: 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.BookmarkLoadOptions): Word.Bookmark; + load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; /** * 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.Bookmark; + load(propertyNames?: string | string[]): Word.TextColumnCollection; /** * 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.Bookmark; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TextColumnCollection; /** * 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.Bookmark; + track(): Word.TextColumnCollection; /** * 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.Bookmark; + untrack(): Word.TextColumnCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.BookmarkData; + toJSON(): Word.Interfaces.TextColumnCollectionData; } /** - * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * Represents options for a new text column in a document or section of a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class BookmarkCollection 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.Bookmark[]; + interface TextColumnAddOptions { /** - * Determines whether the specified bookmark exists. + * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + isEvenlySpaced?: boolean; + /** + * If provided, specifies the spacing between the text columns in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. * - * @param name A bookmark name than cannot include more than 40 characters or more than one word. - * @returns `true` if the bookmark exists. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - exists(name: string): OfficeExtension.ClientResult; + spacing?: number; /** - * Gets a `Bookmark` object by its index in the collection. + * If provided, specifies the width of the new text column in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TextColumn 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; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + spaceAfter: number; + /** + * Specifies the width, in points, of the specified text columns. * - * @param index A number that identifies the index location of a `Bookmark` object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(index: number): Word.Bookmark; + 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.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextColumn): 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.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + load(options?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; /** * 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.BookmarkCollection; + load(propertyNames?: string | string[]): Word.TextColumn; /** * 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.BookmarkCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextColumn; /** * 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.BookmarkCollection; + track(): Word.TextColumn; /** * 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.BookmarkCollection; + untrack(): Word.TextColumn; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BookmarkCollectionData; + toJSON(): Word.Interfaces.TextColumnData; } /** - * Specifies the type of story in a Word document. + * Specifies the case of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum StoryType { + enum CharacterCase { /** - * Main text story. + * Specifies the next case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainText = "MainText", - /** - * Footnotes story. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - footnotes = "Footnotes", - /** - * Endnotes story. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - endnotes = "Endnotes", - /** - * Comments story. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - comments = "Comments", - /** - * Text frame story. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - textFrame = "TextFrame", - /** - * Even pages header story. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - evenPagesHeader = "EvenPagesHeader", + next = "Next", /** - * Primary header story. + * Specifies lowercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + lower = "Lower", /** - * Even pages footer story. + * Specifies uppercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + upper = "Upper", /** - * Primary footer story. + * Specifies title case for each word. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + titleWord = "TitleWord", /** - * First page header story. + * Specifies title case for the sentence. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + titleSentence = "TitleSentence", /** - * First page footer story. + * Specifies toggle case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + toggle = "Toggle", /** - * Footnote separator story. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + halfWidth = "HalfWidth", /** - * Footnote continuation separator story. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + fullWidth = "FullWidth", /** - * Footnote continuation notice story. + * Specifies Katakana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + katakana = "Katakana", /** - * Endnote separator story. + * Specifies Hiragana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + hiragana = "Hiragana", + } + /** + * Specifies the character width of the text in the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CharacterWidth { /** - * Endnote continuation separator story. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + half = "Half", /** - * Endnote continuation notice story. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + full = "Full", } /** - * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the - indexes in the document. + * Specifies the seek view options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Index 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; + enum SeekView { /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. - * + * Main document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + mainDocument = "MainDocument", /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. - * + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + primaryHeader = "PrimaryHeader", /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + firstPageHeader = "FirstPageHeader", /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. - * + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + evenPagesHeader = "EvenPagesHeader", /** - * Gets the number of columns for each page of the index. - * + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly numberOfColumns: number; + primaryFooter = "PrimaryFooter", /** - * Specifies if page numbers are aligned with the right margin in the index. - * + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly rightAlignPageNumbers: boolean; + firstPageFooter = "FirstPageFooter", /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). - * + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly separateAccentedLetterHeadings: boolean; + evenPagesFooter = "EvenPagesFooter", /** - * Specifies the sorting criteria for the index. - * + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + footnotes = "Footnotes", /** - * Specifies the leader character between entries in the index and their associated page numbers. - * + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + endnotes = "Endnotes", /** - * Gets the index type. - * + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.IndexType | "Indent" | "Runin"; - /** - * 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.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Index): void; + currentPageHeader = "CurrentPageHeader", /** - * Deletes this index. - * + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): 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.IndexLoadOptions): Word.Index; - /** - * 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.Index; - /** - * 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.Index; - /** - * 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.Index; - /** - * 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.Index; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.IndexData; + currentPageFooter = "CurrentPageFooter", } /** - * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * Specifies the source documents to show. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class IndexCollection 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.Index[]; + enum ShowSourceDocuments { /** - * Returns an `Index` object that represents a new index added to the document. - * + * Specifies that no source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. - * @param indexAddOptions Optional. The options for adding the index. */ - add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + none = "None", /** - * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. - * + * Specifies that the original source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFormat(): OfficeExtension.ClientResult; + original = "Original", /** - * Gets an `Index` object by its index in the collection. - * + * Specifies that the revised source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of an `Index` object. */ - getItem(index: number): Word.Index; + revised = "Revised", /** - * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. - * + * Specifies that both the original and revised source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range whose text is marked with an `XE` field throughout the document. - * @param markAllEntriesOptions Optional. The options for marking all entries. - */ - markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; - /** - * 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.IndexCollection; - /** - * 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.IndexCollection; - /** - * 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.IndexCollection; - /** - * 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.IndexCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.IndexCollectionData; + both = "Both", } /** - * Represents options for creating an index in a Word document. + * Specifies the special pane options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface IndexAddOptions { - /** - * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. - See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + enum SpecialPane { /** - * If provided, specifies the sorting language to be used for the index being added. - See `LanguageId` for available values. The default value is the installed language of the Word application. - * + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + none = "None", /** - * If provided, specifies the number of columns for each page of the index. - Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. - * + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + primaryHeader = "PrimaryHeader", /** - * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. - * + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + firstPageHeader = "FirstPageHeader", /** - * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. - * + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateAccentedLetterHeadings?: boolean; + evenPagesHeader = "EvenPagesHeader", /** - * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. - * + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + primaryFooter = "PrimaryFooter", /** - * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. - Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. - * + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** - * Represents options for marking all index entries in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface IndexMarkAllEntriesOptions { + firstPageFooter = "FirstPageFooter", /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. - * + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + evenPagesFooter = "EvenPagesFooter", /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". - * + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + footnotes = "Footnotes", /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". - * + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + endnotes = "Endnotes", /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". - * + * Footnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + footnoteContinuationNotice = "FootnoteContinuationNotice", /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. - * + * Footnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. - * + * Footnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + footnoteSeparator = "FootnoteSeparator", /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. - * + * Endnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; - } - /** - * Represents options for marking an index entry in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface IndexMarkEntryOptions { + endnoteContinuationNotice = "EndnoteContinuationNotice", /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. - * + * Endnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". - * + * Endnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + endnoteSeparator = "EndnoteSeparator", /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". - * + * Comments. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + comments = "Comments", /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". - * + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + currentPageHeader = "CurrentPageHeader", /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. - * + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + currentPageFooter = "CurrentPageFooter", /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. - * + * Revisions. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + revisions = "Revisions", /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. - * + * Revisions horizontal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + revisionsHoriz = "RevisionsHoriz", /** - * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. - * + * Revisions vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading?: boolean; + revisionsVert = "RevisionsVert", } /** - * Specifies the type of separator to use for headings. + * Specifies the save options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HeadingSeparator { - /** - * No separator is used for headings. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", - /** - * A blank line is used as a separator for headings. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - blankLine = "BlankLine", + enum SaveConfiguration { /** - * A single letter is used as a separator for headings. + * Specifies not to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + doNotSaveChanges = "DoNotSaveChanges", /** - * A lowercase letter is used as a separator for headings. + * Specifies to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterLow = "LetterLow", + saveChanges = "SaveChanges", /** - * A full-width letter is used as a separator for headings. + * Specifies to prompt to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterFull = "LetterFull", + promptToSaveChanges = "PromptToSaveChanges", } /** - * Represents the position of a dropped capital letter. + * Specifies the page color options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DropPosition { + enum PageColor { /** - * Represents that there's no dropped capital letter. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Represents a normal dropped capital letter. + * Sepia. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + sepia = "Sepia", /** - * Represents a dropped capital letter in the margin. + * Inverse. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - margin = "Margin", + inverse = "Inverse", } /** - * Represents the type of line spacing. + * Specifies the page movement type in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineSpacing { - /** - * Represents single line spacing. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - single = "Single", + enum PageMovementType { /** - * Represents 1.5 line spacing. + * Vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onePt5 = "OnePt5", + vertical = "Vertical", /** - * Represents double line spacing. + * Side to side. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingLayoutMargin { /** - * Represents at least line spacing. + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + automatic = "Automatic", /** - * Represents exact line spacing. + * Hides margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + suppress = "Suppress", /** - * Represents multiple line spacing. + * Shows margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiple = "Multiple", + full = "Full", } /** - * Represents the alignment of a tab stop. + * Specifies the margin for revision balloons in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TabAlignment { + enum RevisionsBalloonMargin { /** - * Represents that the tab stop is aligned to the left. + * Left margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ left = "Left", /** - * Represents that the tab stop is aligned to the center. + * Right margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonWidthType { /** - * Represents that the tab stop is aligned to the right. + * Balloon width as a percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + percent = "Percent", /** - * Represents that the tab stop is aligned to the decimal point. + * Balloon width in points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decimal = "Decimal", + points = "Points", + } + /** + * Specifies the extent of markup visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMarkup { /** - * Represents that the tab stop is aligned to the bar. + * No markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bar = "Bar", + none = "None", /** - * Represents that the tab stop is aligned to the list. + * Simple markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + simple = "Simple", + /** + * All markup. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", } /** - * Represents the type of tight wrap for a text box. + * Specifies the display mode for tracked changes in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextboxTightWrap { + enum RevisionsMode { /** - * Represents that there's no tight wrap. + * Balloon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + balloon = "Balloon", /** - * Represents tight wrap around all lines. + * Inline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + inline = "Inline", /** - * Represents tight wrap around the first and last lines. + * Mixed. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstAndLastLines = "FirstAndLastLines", + mixed = "Mixed", + } + /** + * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsView { /** - * Represents tight wrap around the first line only. + * Final view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstLineOnly = "FirstLineOnly", + final = "Final", /** - * Represents tight wrap around the last line only. + * Original view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastLineOnly = "LastLineOnly", + original = "Original", } /** - * Specifies the filter type for an index. + * Specifies the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFilter { + enum RevisionType { /** - * No filter is applied. + * No revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Aiueo filter is applied. + * Insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - aiueo = "Aiueo", + insert = "Insert", /** - * Akasatana filter is applied. + * Delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - akasatana = "Akasatana", + delete = "Delete", /** - * Chosung filter is applied. + * Property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chosung = "Chosung", + property = "Property", /** - * Low filter is applied. + * Paragraph number revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - low = "Low", + paragraphNumber = "ParagraphNumber", /** - * Medium filter is applied. + * Display field revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + displayField = "DisplayField", /** - * Full filter is applied. + * Reconcile revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the format for an index. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexFormat { + reconcile = "Reconcile", /** - * Template format. + * Conflict revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + conflict = "Conflict", /** - * Classic format. + * Style revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic = "Classic", + style = "Style", /** - * Fancy format. + * Replace revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fancy = "Fancy", + replace = "Replace", /** - * Modern format. + * Paragraph property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modern = "Modern", + paragraphProperty = "ParagraphProperty", /** - * Bulleted format. + * Table property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulleted = "Bulleted", + tableProperty = "TableProperty", /** - * Formal format. + * Section property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formal = "Formal", + sectionProperty = "SectionProperty", /** - * Simple format. + * Style definition revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", - } - /** - * Specifies how an index is sorted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexSortBy { + styleDefinition = "StyleDefinition", /** - * Sort by stroke. + * Moved from revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stroke = "Stroke", + movedFrom = "MovedFrom", /** - * Sort by syllable. + * Moved to revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", - } - /** - * Specifies the type of index to create. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexType { + movedTo = "MovedTo", /** - * Creates an indented index. + * Cell insertion revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent = "Indent", + cellInsertion = "CellInsertion", /** - * Creates a run-in index. + * Cell deletion revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - runin = "Runin", - } - /** - * Specifies the tab leader style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TabLeader { + cellDeletion = "CellDeletion", /** - * Spaces are used as the tab leader. + * Cell merge revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaces = "Spaces", + cellMerge = "CellMerge", /** - * Dots are used as the tab leader. + * Cell split revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dots = "Dots", + cellSplit = "CellSplit", /** - * Dashes are used as the tab leader. + * Conflict insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashes = "Dashes", + conflictInsert = "ConflictInsert", /** - * Lines are used as the tab leader. + * Conflict delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lines = "Lines", + conflictDelete = "ConflictDelete", + } + /** + * Specifies the column width options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColumnWidth { /** - * Heavy lines are used as the tab leader. + * Narrow column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heavy = "Heavy", + narrow = "Narrow", /** - * Middle dots are used as the tab leader. + * Default column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - middleDot = "MiddleDot", + default = "Default", + /** + * Wide column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + wide = "Wide", } /** - * Specifies the area of a table to which to apply special style formatting. + * Specifies the field shading options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ConditionCode { + enum FieldShading { /** - * Applies formatting to the first row in a table. + * Never shade fields. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstRow = "FirstRow", + never = "Never", /** - * Applies formatting to the last row in a table. + * Always shade fields. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastRow = "LastRow", + always = "Always", /** - * Applies formatting to odd-numbered rows. + * Shade fields when selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddRowBanding = "OddRowBanding", + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HorizontalInVerticalType { /** - * Applies formatting to even-numbered rows. + * No formatting is applied to the horizontal text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenRowBanding = "EvenRowBanding", + none = "None", /** - * Applies formatting to the first column in a table. + * The horizontal text is sized to fit in the line of vertical text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + fitInLine = "FitInLine", /** - * Applies formatting to the last column in a table. + * The line of vertical text is sized to accommodate the horizontal text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastColumn = "LastColumn", + resizeLine = "ResizeLine", + } + /** + * Specifies the IME (Input Method Editor) mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ImeMode { /** - * Applies formatting to odd-numbered columns. + * Specifies no control over the IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddColumnBanding = "OddColumnBanding", + noControl = "NoControl", /** - * Applies formatting to even-numbered columns. + * Specifies the IME mode is on. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenColumnBanding = "EvenColumnBanding", + on = "On", /** - * Applies formatting to the last cell in the first row. + * Specifies the IME mode is off. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRightCell = "TopRightCell", + off = "Off", /** - * Applies formatting to the first cell in the first row. + * Specifies the Hiragana IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeftCell = "TopLeftCell", + hiragana = "Hiragana", /** - * Applies formatting to the last cell in the table. + * Specifies the Katakana (double-byte) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRightCell = "BottomRightCell", + katakana = "Katakana", /** - * Applies formatting to first cell in the last row of the table. + * Specifies the Katakana (half-width) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeftCell = "BottomLeftCell", - } - /** - * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DeleteCells { + katakanaHalf = "KatakanaHalf", /** - * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * Specifies the full-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftLeft = "ShiftLeft", + alphaFull = "AlphaFull", /** - * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * Specifies the half-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shiftUp = "ShiftUp", + alpha = "Alpha", /** - * Delete the entire row of cells from the table. + * Specifies the full-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entireRow = "EntireRow", + hangulFull = "HangulFull", /** - * Delete the entire column of cells from the table. + * Specifies the half-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entireColumn = "EntireColumn", + hangul = "Hangul", } /** - * Specifies the rule for determining the height of the specified cells or rows. + * Specifies the Kana type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RowHeightRule { - /** - * The row height is adjusted to accommodate the tallest value in the row. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - auto = "Auto", + enum Kana { /** - * The row height is set to a minimum value. + * Katakana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + katakana = "Katakana", /** - * The row height is set to an exact value. + * Hiragana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + hiragana = "Hiragana", } /** - * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * Specifies the two lines in one type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableDirection { + enum TwoLinesInOneType { /** - * The table is arranged with the first column in the rightmost position. + * No two lines in one. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + none = "None", /** - * The table is arranged with the first column in the leftmost position. + * Two lines in one without brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", - } - /** - * Specifies the character used to separate fields in a table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TableFieldSeparator { + noBrackets = "NoBrackets", /** - * Uses the paragraph marker. + * Two lines in one with parentheses. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + parentheses = "Parentheses", /** - * Uses the tab. + * Two lines in one with square brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tab = "Tab", + squareBrackets = "SquareBrackets", /** - * Uses the comma. + * Two lines in one with angle brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comma = "Comma", + angleBrackets = "AngleBrackets", /** - * Uses the default list separator. + * Two lines in one with curly brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultListSeparator = "DefaultListSeparator", + curlyBrackets = "CurlyBrackets", } /** - * Specifies the table format to apply. + * Specifies the underline type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TableFormatType { + enum Underline { /** - * Applies no formatting to the table. + * No underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ none = "None", /** - * Applies the Simple1 table format. + * Single underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple1 = "Simple1", + single = "Single", /** - * Applies the Simple2 table format. + * Underline words only. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple2 = "Simple2", + words = "Words", /** - * Applies the Simple3 table format. + * Double underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple3 = "Simple3", + double = "Double", /** - * Applies the Classic1 table format. + * Dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic1 = "Classic1", + dotted = "Dotted", /** - * Applies the Classic2 table format. + * Thick underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic2 = "Classic2", + thick = "Thick", /** - * Applies the Classic3 table format. + * Dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic3 = "Classic3", + dash = "Dash", /** - * Applies the Classic4 table format. + * Dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic4 = "Classic4", + dotDash = "DotDash", /** - * Applies the Colorful1 table format. + * Dot dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful1 = "Colorful1", + dotDotDash = "DotDotDash", /** - * Applies the Colorful2 table format. + * Wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful2 = "Colorful2", + wavy = "Wavy", /** - * Applies the Colorful3 table format. + * Heavy wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorful3 = "Colorful3", + wavyHeavy = "WavyHeavy", /** - * Applies the Columns1 table format. + * Heavy dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns1 = "Columns1", + dottedHeavy = "DottedHeavy", /** - * Applies the Columns2 table format. + * Heavy dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns2 = "Columns2", + dashHeavy = "DashHeavy", /** - * Applies the Columns3 table format. + * Heavy dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns3 = "Columns3", + dotDashHeavy = "DotDashHeavy", /** - * Applies the Columns4 table format. + * Heavy dot dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns4 = "Columns4", + dotDotDashHeavy = "DotDotDashHeavy", /** - * Applies the Columns5 table format. + * Long dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columns5 = "Columns5", + dashLong = "DashLong", /** - * Applies the Grid1 table format. + * Heavy long dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid1 = "Grid1", + dashLongHeavy = "DashLongHeavy", /** - * Applies the Grid2 table format. + * Double wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid2 = "Grid2", + wavyDouble = "WavyDouble", + } + /** + * Specifies the view type in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ViewType { /** - * Applies the Grid3 table format. + * Normal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid3 = "Grid3", + normal = "Normal", /** - * Applies the Grid4 table format. + * Outline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid4 = "Grid4", + outline = "Outline", /** - * Applies the Grid5 table format. + * Print. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid5 = "Grid5", + print = "Print", /** - * Applies the Grid6 table format. + * Print preview. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid6 = "Grid6", + printPreview = "PrintPreview", /** - * Applies the Grid7 table format. + * Master. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid7 = "Grid7", + master = "Master", /** - * Applies the Grid8 table format. + * Web. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid8 = "Grid8", + web = "Web", /** - * Applies the List1 table format. + * Reading. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list1 = "List1", + reading = "Reading", /** - * Applies the List2 table format. + * Conflict. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list2 = "List2", + conflict = "Conflict", + } + /** + * Represents the state of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum WindowState { /** - * Applies the List3 table format. + * Represents the normal state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list3 = "List3", + normal = "Normal", /** - * Applies the List4 table format. + * Represents the maximized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list4 = "List4", + maximize = "Maximize", /** - * Applies the List5 table format. + * Represents the minimized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list5 = "List5", + minimize = "Minimize", + } + /** + * Specifies the type of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum WindowType { /** - * Applies the List6 table format. + * Specifies a document window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list6 = "List6", - /** - * Applies the List7 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list7 = "List7", - /** - * Applies the List8 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list8 = "List8", - /** - * Applies the 3D Effects1 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects1 = "ThreeDEffects1", - /** - * Applies the 3D Effects2 table format. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDEffects2 = "ThreeDEffects2", + document = "Document", /** - * Applies the 3D Effects3 table format. + * Specifies a template window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDEffects3 = "ThreeDEffects3", + template = "Template", + } + /** + * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionConvertToTableOptions { /** - * Applies the Contemporary table format. + * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contemporary = "Contemporary", + applyBorders?: boolean; /** - * Applies the Elegant table format. + * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - elegant = "Elegant", + applyColor?: boolean; /** - * Applies the Professional table format. + * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - professional = "Professional", + applyFirstColumn?: boolean; /** - * Applies the Subtle1 table format. + * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle1 = "Subtle1", + applyFont?: boolean; /** - * Applies the Subtle2 table format. + * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subtle2 = "Subtle2", + applyHeadingRows?: boolean; /** - * Applies the Web1 table format. + * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web1 = "Web1", + applyLastColumn?: boolean; /** - * Applies the Web2 table format. + * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web2 = "Web2", + applyLastRow?: boolean; /** - * Applies the Web3 table format. + * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - web3 = "Web3", - } - /** - * Represents the options for the {@link Word.Table | Table.autoFormat} method. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TableAutoFormatOptions { + applyShading?: boolean; /** - * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyBorders?: boolean; + autoFit?: boolean; /** - * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyColor?: boolean; + autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; /** - * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFirstColumn?: boolean; + defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; /** - * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyFont?: boolean; + format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; /** - * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyHeadingRows?: boolean; + initialColumnWidth?: number; /** - * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastColumn?: boolean; + numColumns?: number; /** - * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLastRow?: boolean; + numRows?: number; /** - * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * If provided, specifies the character used to separate text into cells. The default value is `-`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyShading?: boolean; + separator?: string; + } + /** + * Represents the options for the {@link Word.Selection | Selection.delete} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionDeleteOptions { /** - * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoFit?: boolean; + count?: number; /** - * If provided, specifies the format to apply. The default value is `simple1`. + * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * Represents the options for the {@link Word.Selection | Selection.goTo} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableCellCollectionSplitOptions { + interface SelectionGoToOptions { /** - * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mergeBeforeSplit?: boolean; + count?: number; /** - * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numColumns?: number; + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numRows?: number; + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + /** + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } /** - * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableCellFormulaOptions { + interface SelectionInsertCrossReferenceOptions { /** - * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formula?: string; + includePosition?: boolean; /** - * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numFormat?: string; - } - /** - * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TableConvertToTextOptions { + insertAsHyperlink?: boolean; /** - * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestedTables?: boolean; + separateNumbers?: boolean; /** - * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + separatorString?: string; } /** - * Represents the options for the {@link Word.Table | Table.sort} method. + * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableSortOptions { + interface SelectionInsertDateTimeOptions { /** - * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectionalSort?: boolean; + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; /** - * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caseSensitive?: boolean; + dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; /** - * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - excludeHeader?: boolean; + dateTimeFormat?: string; /** - * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber?: string; + insertAsField?: boolean; /** - * If provided, specifies the second field to sort by. + * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber2?: string; + insertAsFullWidth?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionInsertFormulaOptions { /** - * If provided, specifies the third field to sort by. + * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. + The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. + + - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. + + - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldNumber3?: string; + formula?: string; /** - * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies the format for the result of the `= (Formula)` field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreArabicThe?: boolean; + numberFormat?: string; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionInsertSymbolOptions { /** - * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreDiacritics?: boolean; + bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; /** - * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies the name of the font that contains the symbol. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreHebrew?: boolean; + font?: string; /** - * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ignoreKashida?: boolean; + unicode?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionMoveLeftRightOptions { /** - * If provided, specifies the sorting language. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + count?: number; /** - * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + extend?: Word.MovementType | "Move" | "Extend"; /** - * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.move} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionMoveOptions { /** - * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + count?: number; /** - * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * If provided, specifies the unit by which to move the ending character position. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionMoveStartEndOptions { /** - * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + count?: number; /** - * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents a list of the names of all the available fonts. + * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class FontNameCollection 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; + interface SelectionMoveUpDownOptions { /** - * Returns the number of items in the collection. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getCount(): OfficeExtension.ClientResult; + count?: number; /** - * Gets the font name at the specified index. + * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The zero-based index of the font name to retrieve. - */ - getItemAt(index: number): OfficeExtension.ClientResult; - /** - * 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.FontNameCollection; + extend?: Word.MovementType | "Move" | "Extend"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the unit by which to move the selection. The default value is `line`. * - * @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.FontNameCollection; - /** - * 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.FontNameCollection; - /** - * 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.FontNameCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): { - [key: string]: string; - }; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * Represents the options for the {@link Word.Selection | Selection.next} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class ListTemplateCollection 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.ListTemplate[]; + interface SelectionNextOptions { /** - * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * If provided, specifies the number of units by which you want to move ahead. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for adding a new list template. */ - add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + count?: number; /** - * Gets a `ListTemplate` object by its index in the collection. + * If provided, specifies the type of units by which to move the selection. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `ListTemplate` object. - */ - getItem(index: number): Word.ListTemplate; - /** - * 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.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * 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.ListTemplateCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ListTemplateCollectionData; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * Represents the options for the {@link Word.Selection | Selection.previous} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ListTemplateCollectionAddOptions { + interface SelectionPreviousOptions { /** - * If provided, specifies the name of the list template to be added. + * If provided, specifies the number of units by which you want to move. The default value is 1. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + count?: number; /** - * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * If provided, specifies the type of unit by which to move the selection. The default value is `character`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineNumbered?: boolean; + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class ListTemplateGallery extends OfficeExtension.ClientObject { + class Selection 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; /** - * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplates: Word.ListTemplateCollection; + readonly borders: Word.BorderUniversalCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `RangeScopedCollection` object that represents each character in the selection. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListTemplateGallery; + readonly characters: Word.RangeScopedCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns a `CommentCollection` object that represents all the comments in the selection. * - * @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.ListTemplateGallery; - /** - * 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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ListTemplateGallery; + readonly comments: Word.CommentCollection; /** - * 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. + * Returns a `FieldCollection` object that represents all the fields in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ListTemplateGallery; + readonly fields: 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.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + * Returns the `Font` object that represents the character formatting of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListTemplateGalleryData; - } - /** - * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ListTemplateGalleryCollection 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.ListTemplateGallery[]; + readonly font: Word.Font; /** - * Gets a `ListTemplateGallery` object by its type in the collection. + * Specifies a `Range` object that includes the formatted text in the range or selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type The type of list template gallery to retrieve. */ - getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + formattedText: Word.Range; /** - * Gets a `ListTemplateGallery` object by its type in the collection. + * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param type The type of list template gallery to retrieve. */ - getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + readonly paragraphs: Word.ParagraphCollection; /** - * Gets a `ListTemplateGallery` object by its index in the collection. + * Returns the `Range` object for the portion of the document contained in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `ListTemplateGallery` object. */ - getItem(index: number): Word.ListTemplateGallery; + readonly range: Word.Range; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the `SectionCollection` object in the selection. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ListTemplateGalleryCollection; + readonly sections: Word.SectionCollection; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Returns the `RangeScopedCollection` object for each sentence in the selection. * - * @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. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ListTemplateGalleryCollection; + readonly sentences: Word.RangeScopedCollection; /** - * 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. + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ListTemplateGalleryCollection; + readonly shading: Word.ShadingUniversal; /** - * 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. + * Returns the `TableCollection` object in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ListTemplateGalleryCollection; + readonly tables: 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.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Returns the tables at the outermost nesting level in the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; - } - /** - * Describes the types of list template galleries available. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListTemplateGalleryType { + readonly topLevelTables: Word.TableCollection; /** - * Represents the bullet list gallery. + * Returns the `RangeScopedCollection` object that represents each word in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bullets = "Bullets", + readonly words: Word.RangeScopedCollection; /** - * Represents the number list gallery. + * Specifies the ending character position of the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - number = "Number", + end: number; /** - * Represents the outline number list gallery. + * Specifies the width in which Word fits the text in the current selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlineNumbered = "OutlineNumbered", - } - /** - * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CoauthoringLockType { + fitTextWidth: number; /** - * Reserved for future use. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly hasNoProofing: boolean; /** - * Represents that the lock is a reservation. + * Returns whether the selection in the specified window or pane is active. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reservation = "Reservation", + readonly isActive: boolean; /** - * Represents that the lock is ephemeral. + * Specifies whether column selection mode is active. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ephemeral = "Ephemeral", + isColumnSelectModeActive: boolean; /** - * Represents that the lock has changed. + * Returns whether the selection is at the end-of-row mark in a table. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changed = "Changed", - } - /** - * Represents the classes of users who can edit authorized portions of a protected (read-only) document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum EditorType { + readonly isEndOfRowMark: boolean; /** - * Represents the current user of the document. + * Specifies whether Extend mode is active. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - current = "Current", + isExtendModeActive: boolean; /** - * Represents the Editors group for documents that use Information Rights Management. + * Returns whether the insertion point is at the end of a line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - editors = "Editors", + readonly isInsertionPointAtEndOfLine: boolean; /** - * Represents all users who open a document. + * Specifies whether the beginning of the selection is active. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - everyone = "Everyone", + isStartActive: boolean; /** - * Represents the Owners group for documents that use Information Rights Management. + * Specifies whether Word has detected the language of the selected text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owners = "Owners", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", - } - namespace Interfaces { + languageDetected: boolean; /** - * Provides ways to load properties of only a subset of members of a collection. + * Returns the language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface CollectionLoadOptions { + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the East Asian language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the language for the selection that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyLength: number; + /** + * Returns the story type for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text: string; + /** + * Returns the selection type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + /** + * Calculates the first mathematical expression within the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The result of the calculation. + */ + calculate(): OfficeExtension.ClientResult; + /** + * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cancelMode(): void; + /** + * Removes character formatting applied through character styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearCharacterStyleFormatting(): void; + /** + * Removes character and paragraph formatting from the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearFormatting(): void; + /** + * Removes manually applied character formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualCharacterFormatting(): void; + /** + * Removes manually applied paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualParagraphFormatting(): void; + /** + * Removes all paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphFormatting(): void; + /** + * Removes paragraph formatting applied through paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphStyle(): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: Word.CollapseDirection): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: "Start" | "End"): void; + /** + * Converts text within a range to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for converting text to a table. + * @returns A `Table` object that represents the newly created table. + */ + convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + /** + * Copies the selection to the Clipboard as a picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyAsPictureToClipboard(): void; + /** + * Copies the character formatting of the first character in the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyFormat(): void; + /** + * Copies the selection to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyToClipboard(): void; + /** + * Adds a default-sized text box around the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + createTextBox(): void; + /** + * Removes the selected content from the document and moves it to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; + /** + * Deletes the specified number of characters or words. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for deleting text. + * @returns The number of characters deleted. + */ + delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + /** + * Analyzes the selected text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): void; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + /** + * Expands the selection to include the entire story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + expandToWholeStory(): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: Word.OperationUnit): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + /** + * Returns a `Range` object that represents the next unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `next` operation. + * @returns A `Range` object that represents the next unit relative to the selection. + */ + getNextRange(options?: Word.SelectionNextOptions): Word.Range; + /** + * Returns a `Range` object that represents the previous unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `previous` operation. + * @returns A `Range` object that represents the previous unit relative to the selection. + */ + getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + /** + * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `goTo` operation. + * @returns A `Range` object that is now selected. + */ + goTo(options?: Word.SelectionGoToOptions): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Inserts the specified text at the end of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Text to insert. + */ + insertAfter(text: string): void; + /** + * Inserts the specified text before the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Text to insert. + */ + insertBefore(text: string): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + /** + * Inserts columns to the left of the column that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsLeft(): void; + /** + * Inserts columns to the right of the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsRight(): void; + /** + * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Options for inserting the date or time. + */ + insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for inserting the formula. + */ + insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + /** + * Inserts a new page at the position of the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertNewPage(): void; + /** + * Inserts a paragraph mark after the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphAfter(): void; + /** + * Inserts a new paragraph before the selection or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphBefore(): void; + /** + * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphStyleSeparator(): void; + /** + * Inserts rows above the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsAbove(numRows: number): void; + /** + * Inserts rows below the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsBelow(numRows: number): void; + /** + * Inserts a symbol in place of the specified selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characterNumber The character number of the symbol. + * @param options Optional. Options for inserting the symbol. + */ + insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + /** + * Inserts the specified text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Text The text to insert. + */ + insertText(Text: string): void; + /** + * Inserts the specified XML into the document at the cursor, replacing any selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xml The XML string to insert. + * @param transform Optional. XSL transform to apply. + */ + insertXML(xml: string, transform?: string): void; + /** + * Returns whether the selection is equal to the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is equal to the specified range. + */ + isEqual(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns `true` if the selection is contained within the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is contained within the specified range. + */ + isInRange(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns whether the selection is in the same story as the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is in the same story as the specified range. + */ + isInStory(range: Word.Range): OfficeExtension.ClientResult; + /** + * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving the selection. + * @returns The number of characters by which the selection was moved. + */ + move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + /** + * Moves the selection down. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving down. + * @returns The number of characters by which the selection was moved. + */ + moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving end. + * @returns The number of characters by which the selection was moved. + */ + moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the end position of the selection until any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving left. + * @returns The number of characters by which the selection was moved. + */ + moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the selection to the right. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving right. + * @returns The number of characters by which the selection was moved. + */ + moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `moveStart` operation. + * @returns The number of characters by which the selection was moved. + */ + moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection up. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving up. + * @returns The number of characters by which the selection was moved. + */ + moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Selects the next field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The next field. + */ + nextField(): Word.Field; + /** + * Moves the selection to the next subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSubdocument(): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The format paste type for table cells + */ + pasteAndFormat(type: Word.PasteFormatType): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The format paste type for table cells + */ + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + /** + * Pastes and formats a Microsoft Excel table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param linkedToExcel Whether the table is linked to Excel. + * @param wordFormatting Whether to apply Word formatting. + * @param rtf Whether to paste as Rich Text Format (RTF). + */ + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + /** + * Applies formatting copied with the `copyFormat` method to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteFormat(): void; + /** + * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAppendTable(): void; + /** + * Pastes a cell or group of cells as a nested table into the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAsNestedTable(): void; + /** + * Selects and returns the previous field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The previous field. + */ + previousField(): Word.Field; + /** + * Moves the selection to the previous subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSubdocument(): void; + /** + * Replaces the selection with a new paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replaceParagraph(): void; + /** + * Selects the current text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Selects the entire cell containing the current selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCell(): void; + /** + * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectColumn(): void; + /** + * Extends the selection forward until text with a different paragraph alignment is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentAlignment(): void; + /** + * Extends the selection forward until text with a different color is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentColor(): void; + /** + * Extends the selection forward until text in a different font or font size is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentFont(): void; + /** + * Extends the selection forward until text with different left or right paragraph indents is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentIndent(): void; + /** + * Extends the selection forward until a paragraph with different line spacing is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentSpacing(): void; + /** + * Extends the selection forward until a paragraph with different tab stops is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentTabs(): void; + /** + * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectRow(): void; + /** + * Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param start The starting character position of the current story. + * @param end The ending character position of the current story. + */ + setRange(start: number, end: number): void; + /** + * Shrinks the selection to the next smaller unit of text. + The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrink(): void; + /** + * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrinkDiscontiguousSelection(): void; + /** + * Inserts an empty paragraph above the first row in the selection. + If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitTable(): void; + /** + * Switches the selection between a Unicode character and its corresponding hexadecimal value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleCharacterCode(): void; + /** + * Deletes the character preceding the selection (if collapsed) or the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + typeBackspace(): 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.SelectionLoadOptions): Word.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * 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.Selection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SelectionData; + } + /** + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class RangeScopedCollection 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.Range[]; + /** + * Gets a `Range` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `Range` object in the collection. + */ + getItem(index: number): Word.Range; + /** + * 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.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * 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.RangeScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RangeScopedCollectionData; + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddPage = "OddPage", + } + /** + * Specifies how a table is resized to fit its contents or the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoFitBehavior { + /** + * Disables automatic resizing. The table retains its current size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fixedSize = "FixedSize", + /** + * Automatically resizes the table columns to fit the contents. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + content = "Content", + /** + * Automatically resizes the table to fit the window width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + } + /** + * Specifies the type of bidirectional calendar to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarTypeBidirectional { + /** + * Uses the Gregorian calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gregorian = "Gregorian", + /** + * Uses the Bidirectional calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + } + /** + * Specifies the type of caption label to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionLabelType { + /** + * Specifies a figure caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + figure = "Figure", + /** + * Specifies a table caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an equation caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + } + /** + * Specifies the position of a caption relative to the object it describes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionPosition { + /** + * Places the caption above the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + above = "Above", + /** + * Places the caption below the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + below = "Below", + } + /** + * Specifies the direction in which to collapse a selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CollapseDirection { + /** + * Collapses the selection to the start position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start = "Start", + /** + * Collapses the selection to the end position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end = "End", + } + /** + * Specifies the language to use for date formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DateLanguage { + /** + * Uses the bidirectional date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Uses the latin date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies the default behavior when inserting a new table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultTableBehavior { + /** + * Disables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableAutoFit = "DisableAutoFit", + /** + * Enables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enableAutoFit = "EnableAutoFit", + } + /** + * Specifies the location of endnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EndnoteLocation { + /** + * Places endnotes at the end of the section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfSection = "EndOfSection", + /** + * Places endnotes at the end of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfDocument = "EndOfDocument", + } + /** + * Specifies the font bias to use when formatting East Asian text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FontBias { + /** + * Uses the default font bias. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standard = "Standard", + /** + * Uses the font bias for Far East text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEast = "FarEast", + /** + * No font bias specified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpecified = "NoSpecified", + } + /** + * Specifies the location of footnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FootnoteLocation { + /** + * Places footnotes at the bottom of the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomOfPage = "BottomOfPage", + /** + * Places footnotes below the text on the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beneathText = "BeneathText", + } + /** + * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToDirection { + /** + * Moves to the first item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + first = "First", + /** + * Moves to the last item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + last = "Last", + /** + * Moves to the next item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next = "Next", + /** + * Moves to the previous item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous = "Previous", + } + /** + * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToItem { + /** + * Moves to a bookmark. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Moves to a comment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comment = "Comment", + /** + * Moves to a endnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + /** + * Moves to a field. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + field = "Field", + /** + * Moves to a footnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Moves to a graphic. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + graphic = "Graphic", + /** + * Moves to a heading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Moves to a line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Moves to a page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Moves to a section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Moves to a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Moves to an embedded object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + embeddedObject = "EmbeddedObject", + /** + * Moves to an equation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + /** + * Moves to a percent. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent = "Percent", + /** + * Moves to a spelling error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingError = "SpellingError", + /** + * Moves to a grammatical error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammaticalError = "GrammaticalError", + /** + * Moves to a proofreading error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + proofreadingError = "ProofreadingError", + } + /** + * Specifies the type of movement when navigating through a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MovementType { + /** + * Moves the insertion point or selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + move = "Move", + /** + * Extends the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extend = "Extend", + } + /** + * Specifies the numbering style to use for footnotes or endnotes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NoteNumberStyle { + /** + * Uses Arabic numerals (1, 2, 3...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabic = "Arabic", + /** + * Uses uppercase Roman numerals (I, II, III...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseRoman = "UppercaseRoman", + /** + * Uses lowercase Roman numerals (i, ii, iii...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseRoman = "LowercaseRoman", + /** + * Uses uppercase letters (A, B, C...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseLetter = "UppercaseLetter", + /** + * Uses lowercase letters (a, b, c...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseLetter = "LowercaseLetter", + /** + * Uses a symbol instead of a number. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + symbol = "Symbol", + /** + * Uses full-width Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicFullWidth = "ArabicFullWidth", + /** + * Uses Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanji = "Kanji", + /** + * Uses Kanji digits. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiDigit = "KanjiDigit", + /** + * Uses traditional Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiTraditional = "KanjiTraditional", + /** + * Uses numbers enclosed in circles. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberInCircle = "NumberInCircle", + /** + * Uses Hanja characters with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaRead = "HanjaRead", + /** + * Uses Hanja digits with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaReadDigit = "HanjaReadDigit", + /** + * Uses traditional Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral1 = "traditionalChineseNumeral1", + /** + * Uses traditional Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral2 = "traditionalChineseNumeral2", + /** + * Uses simplified Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + /** + * Uses simplified Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + /** + * Uses Hebrew letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter1 = "HebrewLetter1", + /** + * Uses Arabic letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter1 = "ArabicLetter1", + /** + * Uses Hebrew letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter2 = "HebrewLetter2", + /** + * Uses Arabic letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter2 = "ArabicLetter2", + /** + * Uses Hindi letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter1 = "HindiLetter1", + /** + * Uses Hindi letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter2 = "HindiLetter2", + /** + * Uses Hindi Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiArabic = "HindiArabic", + /** + * Uses Hindi cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiCardinalText = "HindiCardinalText", + /** + * Uses Thai letters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiLetter = "ThaiLetter", + /** + * Uses Thai Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiArabic = "ThaiArabic", + /** + * Uses Thai cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiCardinalText = "ThaiCardinalText", + /** + * Uses Vietnamese cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vietnameseCardinalText = "vietnameseCardinalText", + } + /** + * Specifies the unit of measurement used in Word operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OperationUnit { + /** + * Specifies a character unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Specifies a word unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + word = "Word", + /** + * Specifies a sentence unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sentence = "Sentence", + /** + * Specifies a paragraph unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Specifies a line unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Specifies a story unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + story = "Story", + /** + * Specifies a screen unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screen = "Screen", + /** + * Specifies a section unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Specifies a column unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Specifies a row unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Specifies a window unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + /** + * Specifies a cell unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cell = "Cell", + /** + * Specifies a character format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterFormat = "CharacterFormat", + /** + * Specifies a paragraph format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraphFormat = "ParagraphFormat", + /** + * Specifies a table unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an item unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + item = "Item", + } + /** + * Specifies the format to use when pasting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteDataType { + /** + * Pastes the data as an OLE object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oleObject = "OleObject", + /** + * Pastes the data as rich text format (RTF). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rtf = "Rtf", + /** + * Pastes the data as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text = "Text", + /** + * Pastes the data as a metafile picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metafilePicture = "MetafilePicture", + /** + * Pastes the data as a bitmap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bitmap = "Bitmap", + /** + * Pastes the data as a device-independent bitmap (DIB). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + deviceIndependentBitmap = "DeviceIndependentBitmap", + /** + * Pastes the data as a hyperlink. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlink = "Hyperlink", + /** + * Pastes the data as a shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", + /** + * Pastes the data as an enhanced metafile. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enhancedMetafile = "EnhancedMetafile", + /** + * Pastes the data as HTML. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + html = "Html", + } + /** + * Specifies the type of formatting when paste to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteFormatType { + /** + * Uses the default paste behavior. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteDefault = "PasteDefault", + /** + * Pastes text into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellText = "SingleCellText", + /** + * Pastes a table into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellTable = "SingleCellTable", + /** + * Continues numbering from the previous list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listContinueNumbering = "ListContinueNumbering", + /** + * Restarts numbering for the new list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listRestartNumbering = "ListRestartNumbering", + /** + * Appends the pasted table to the existing table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableAppendTable = "TableAppendTable", + /** + * Inserts the pasted table as new rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableInsertAsRows = "TableInsertAsRows", + /** + * Inserts the pasted table with its original formatting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOriginalFormatting = "TableOriginalFormatting", + /** + * Pastes a chart as a picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartPicture = "ChartPicture", + /** + * Pastes a chart as an editable chart. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chart = "Chart", + /** + * Pastes a chart with a link to the source data. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartLinked = "ChartLinked", + /** + * Applies the original formatting of the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatOriginalFormatting = "FormatOriginalFormatting", + /** + * Applies surrounding formatting with emphasis. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + /** + * Pastes content as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatPlainText = "FormatPlainText", + /** + * Overwrites existing cells with the pasted table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOverwriteCells = "TableOverwriteCells", + /** + * Combines the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listCombineWithExistingList = "ListCombineWithExistingList", + /** + * Prevents merging the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listDontMerge = "ListDontMerge", + /** + * Uses the destination styles for the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useDestinationStylesRecovery = "UseDestinationStylesRecovery", + } + /** + * Specifies the kind of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceKind { + /** + * Inserts the full text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contentText = "ContentText", + /** + * Inserts the number of the referenced item with relative context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberRelativeContext = "NumberRelativeContext", + /** + * Inserts only the number of the referenced item without context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberNoContext = "NumberNoContext", + /** + * Inserts the number of the referenced item with full context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFullContext = "NumberFullContext", + /** + * Inserts the entire caption of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireCaption = "EntireCaption", + /** + * Inserts only the label and number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyLabelAndNumber = "OnlyLabelAndNumber", + /** + * Inserts only the caption text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyCaptionText = "OnlyCaptionText", + /** + * Inserts the footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumber = "FootnoteNumber", + /** + * Inserts the endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumber = "EndnoteNumber", + /** + * Inserts the page number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageNumber = "PageNumber", + /** + * Inserts the position of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position = "Position", + /** + * Inserts the formatted footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumberFormatted = "FootnoteNumberFormatted", + /** + * Inserts the formatted endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumberFormatted = "EndnoteNumberFormatted", + } + /** + * Specifies the type of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceType { + /** + * Refers to a numbered item in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberedItem = "NumberedItem", + /** + * Refers to a heading in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Refers to a bookmark in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Refers to a footnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Refers to an endnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + } + /** + * Specifies the type of selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SelectionType { + /** + * No selection is made. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSelection = "NoSelection", + /** + * Represents an insertion point (IP) selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertionPoint = "InsertionPoint", + /** + * Represents a normal selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a frame selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame = "Frame", + /** + * Represents a column selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Represents a row selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Represents a block selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + block = "Block", + /** + * Represents an inline shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + inlineShape = "InlineShape", + /** + * Represents a shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectionShape = "SelectionShape", + } + /** + * Specifies the type of field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortFieldType { + /** + * Sorts content alphanumerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alphanumeric = "Alphanumeric", + /** + * Sorts content numerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numeric = "Numeric", + /** + * Sorts content by date. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date = "Date", + /** + * Sorts content by syllables. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + /** + * Sorts content using the Japanese JIS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + japanJis = "JapanJis", + /** + * Sorts content by stroke count. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sorts content using the Korean KS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + koreaKs = "KoreaKs", + } + /** + * Specifies the sort order. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortOrder { + /** + * Sorts in ascending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ascending = "Ascending", + /** + * Sorts in descending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + descending = "Descending", + } + /** + * Specifies where and what type of cells to add to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableCellInsertionLocation { + /** + * Inserts new cells to the left of the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRight = "ShiftRight", + /** + * Inserts new cells above the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftDown = "ShiftDown", + /** + * Inserts an entire row above the row that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRowDown = "ShiftRowDown", + /** + * Inserts an entire column to the left of the column that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftColumnRight = "ShiftColumnRight", + } + /** + * Specifies the predefined table formatting options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormat { + /** + * No table format is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the simple 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the simple 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the simple 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the classic 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the classic 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the classic 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the classic 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the colorful 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the colorful 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the colorful 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the columns 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the columns 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the columns 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the columns 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the columns 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the grid 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the grid 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the grid 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the grid 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the grid 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the grid 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the grid 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the grid 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the list 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the list 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the list 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the list 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the list 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the list 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the list 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the list 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D effects 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D effects 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D effects 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the subtle 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the subtle 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the web 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the web 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the web 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Specifies the orientation of text in a text frame or shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextOrientation { + /** + * Text is horizontal. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontal = "Horizontal", + /** + * Text is vertical with letters rotated 90 degrees clockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upward = "Upward", + /** + * Text is vertical with letters rotated 90 degrees counterclockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + downward = "Downward", + /** + * Text is vertical and reads downward from the top, right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalFarEast = "VerticalFarEast", + /** + * Text is horizontal but from right to left to accommodate right-to-left languages. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalRotatedFarEast = "HorizontalRotatedFarEast", + /** + * Text is vertical and reads downward from the top, left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vertical = "Vertical", + } + /** + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Bookmark 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; + /** + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * 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.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bookmark): void; + /** + * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): 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.BookmarkLoadOptions): Word.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * 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.Bookmark; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BookmarkData; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class BookmarkCollection 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.Bookmark[]; + /** + * Determines whether the specified bookmark exists. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name A bookmark name than cannot include more than 40 characters or more than one word. + * @returns `true` if the bookmark exists. + */ + exists(name: string): OfficeExtension.ClientResult; + /** + * Gets a `Bookmark` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `Bookmark` object. + */ + getItem(index: number): Word.Bookmark; + /** + * 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.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * 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.BookmarkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BookmarkCollectionData; + } + /** + * Specifies the type of story in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Index 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; + /** + * Returns a `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + /** + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly rightAlignPageNumbers: boolean; + /** + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.IndexType | "Indent" | "Runin"; + /** + * 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.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Index): void; + /** + * Deletes this index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): 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.IndexLoadOptions): Word.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * 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.Index; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.IndexData; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class IndexCollection 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.Index[]; + /** + * Returns an `Index` object that represents a new index added to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. + * @param indexAddOptions Optional. The options for adding the index. + */ + add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + /** + * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Gets an `Index` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of an `Index` object. + */ + getItem(index: number): Word.Index; + /** + * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range whose text is marked with an `XE` field throughout the document. + * @param markAllEntriesOptions Optional. The options for marking all entries. + */ + markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * 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.IndexCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.IndexCollectionData; + } + /** + * Represents options for creating an index in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexAddOptions { + /** + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberOfColumns?: number; + /** + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightAlignPageNumbers?: boolean; + /** + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.IndexType | "Indent" | "Runin"; + } + /** + * Represents options for marking all index entries in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexMarkAllEntriesOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + } + /** + * Represents options for marking an index entry in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexMarkEntryOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + /** + * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reading?: boolean; + } + /** + * Specifies the type of separator to use for headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + } + /** + * Represents the type of line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineSpacing { + /** + * Represents single line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Represents 1.5 line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onePt5 = "OnePt5", + /** + * Represents double line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + double = "Double", + /** + * Represents at least line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * Represents exact line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + /** + * Represents multiple line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + multiple = "Multiple", + } + /** + * Represents the alignment of a tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list = "List", + } + /** + * Represents the type of tight wrap for a text box. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextboxTightWrap { + /** + * Represents that there's no tight wrap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents tight wrap around all lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", + /** + * Represents tight wrap around the first and last lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstAndLastLines = "FirstAndLastLines", + /** + * Represents tight wrap around the first line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstLineOnly = "FirstLineOnly", + /** + * Represents tight wrap around the last line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastLineOnly = "LastLineOnly", + } + /** + * Specifies the filter type for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + middleDot = "MiddleDot", + } + /** + * Specifies the area of a table to which to apply special style formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ConditionCode { + /** + * Applies formatting to the first row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstRow = "FirstRow", + /** + * Applies formatting to the last row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastRow = "LastRow", + /** + * Applies formatting to odd-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddRowBanding = "OddRowBanding", + /** + * Applies formatting to even-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenRowBanding = "EvenRowBanding", + /** + * Applies formatting to the first column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstColumn = "FirstColumn", + /** + * Applies formatting to the last column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastColumn = "LastColumn", + /** + * Applies formatting to odd-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddColumnBanding = "OddColumnBanding", + /** + * Applies formatting to even-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenColumnBanding = "EvenColumnBanding", + /** + * Applies formatting to the last cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRightCell = "TopRightCell", + /** + * Applies formatting to the first cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeftCell = "TopLeftCell", + /** + * Applies formatting to the last cell in the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRightCell = "BottomRightCell", + /** + * Applies formatting to first cell in the last row of the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeftCell = "BottomLeftCell", + } + /** + * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DeleteCells { + /** + * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftLeft = "ShiftLeft", + /** + * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftUp = "ShiftUp", + /** + * Delete the entire row of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireRow = "EntireRow", + /** + * Delete the entire column of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireColumn = "EntireColumn", + } + /** + * Specifies the rule for determining the height of the specified cells or rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RowHeightRule { + /** + * The row height is adjusted to accommodate the tallest value in the row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", + /** + * The row height is set to a minimum value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * The row height is set to an exact value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + } + /** + * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableDirection { + /** + * The table is arranged with the first column in the rightmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * The table is arranged with the first column in the leftmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the character used to separate fields in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFieldSeparator { + /** + * Uses the paragraph marker. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Uses the tab. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tab = "Tab", + /** + * Uses the comma. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comma = "Comma", + /** + * Uses the default list separator. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultListSeparator = "DefaultListSeparator", + } + /** + * Specifies the table format to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormatType { + /** + * Applies no formatting to the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the Simple1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the Simple2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the Simple3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the Classic1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the Classic2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the Classic3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the Classic4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the Colorful1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the Colorful2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the Colorful3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the Columns1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the Columns2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the Columns3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the Columns4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the Columns5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the Grid1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the Grid2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the Grid3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the Grid4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the Grid5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the Grid6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the Grid7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the Grid8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the List1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the List2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the List3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the List4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the List5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the List6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the List7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the List8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D Effects1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D Effects2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D Effects3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the Contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the Elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the Professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the Subtle1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the Subtle2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the Web1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the Web2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the Web3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableAutoFormatOptions { + /** + * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyBorders?: boolean; + /** + * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyColor?: boolean; + /** + * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFirstColumn?: boolean; + /** + * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFont?: boolean; + /** + * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyHeadingRows?: boolean; + /** + * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastColumn?: boolean; + /** + * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastRow?: boolean; + /** + * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyShading?: boolean; + /** + * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoFit?: boolean; + /** + * If provided, specifies the format to apply. The default value is `simple1`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + } + /** + * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableCellCollectionSplitOptions { + /** + * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mergeBeforeSplit?: boolean; + /** + * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numColumns?: number; + /** + * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numRows?: number; + } + /** + * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableCellFormulaOptions { + /** + * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formula?: string; + /** + * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numFormat?: string; + } + /** + * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableConvertToTextOptions { + /** + * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nestedTables?: boolean; + /** + * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + } + /** + * Represents the options for the {@link Word.Table | Table.sort} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableSortOptions { + /** + * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectionalSort?: boolean; + /** + * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caseSensitive?: boolean; + /** + * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + excludeHeader?: boolean; + /** + * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber?: string; + /** + * If provided, specifies the second field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber2?: string; + /** + * If provided, specifies the third field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber3?: string; + /** + * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreArabicThe?: boolean; + /** + * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreDiacritics?: boolean; + /** + * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreHebrew?: boolean; + /** + * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreKashida?: boolean; + /** + * If provided, specifies the sorting language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + } + /** + * Represents a list of the names of all the available fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class FontNameCollection 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; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the font name at the specified index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The zero-based index of the font name to retrieve. + */ + getItemAt(index: number): OfficeExtension.ClientResult; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * 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.FontNameCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateCollection 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.ListTemplate[]; + /** + * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for adding a new list template. + */ + add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + /** + * Gets a `ListTemplate` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `ListTemplate` object. + */ + getItem(index: number): Word.ListTemplate; + /** + * 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.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * 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.ListTemplateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateCollectionData; + } + /** + * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListTemplateCollectionAddOptions { + /** + * If provided, specifies the name of the list template to be added. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered?: boolean; + } + /** + * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateGallery 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; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * 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.ListTemplateGallery; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryData; + } + /** + * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateGalleryCollection 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.ListTemplateGallery[]; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `ListTemplateGallery` object. + */ + getItem(index: number): Word.ListTemplateGallery; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * 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.ListTemplateGalleryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + } + /** + * Describes the types of list template galleries available. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListTemplateGalleryType { + /** + * Represents the bullet list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bullets = "Bullets", + /** + * Represents the number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + number = "Number", + /** + * Represents the outline number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered = "OutlineNumbered", + } + /** + * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CoauthoringLockType { + /** + * Reserved for future use. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents that the lock is a reservation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reservation = "Reservation", + /** + * Represents that the lock is ephemeral. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ephemeral = "Ephemeral", + /** + * Represents that the lock has changed. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + changed = "Changed", + } + /** + * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EditorType { + /** + * Represents the current user of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + current = "Current", + /** + * Represents the Editors group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + editors = "Editors", + /** + * Represents all users who open a document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + everyone = "Everyone", + /** + * Represents the Owners group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owners = "Owners", + } + enum ErrorCodes { + accessDenied = "AccessDenied", + generalException = "GeneralException", + invalidArgument = "InvalidArgument", + itemNotFound = "ItemNotFound", + notAllowed = "NotAllowed", + notImplemented = "NotImplemented", + searchDialogIsOpen = "SearchDialogIsOpen", + searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + } + namespace Interfaces { + /** + * 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. + */ + $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. + */ + $skip?: number; + } + /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ + interface EditorUpdateData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ + interface ConflictCollectionUpdateData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ + interface ConflictUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + interface ApplicationUpdateData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage?: boolean; + } + /** 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] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + interface BorderUpdateData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ + interface BorderUniversalUpdateData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + interface BorderCollectionUpdateData { + /** + * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderColor?: string; + /** + * Specifies the border type of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + /** + * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderColor?: string; + /** + * Specifies the border type of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ + interface BorderUniversalCollectionUpdateData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ + interface BreakUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ + interface BreakCollectionUpdateData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ + interface BuildingBlockUpdateData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: string; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + interface CheckboxContentControlUpdateData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ + interface CoauthoringLockUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ + interface CoauthoringLockCollectionUpdateData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ + interface CoauthorCollectionUpdateData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ + interface CoauthoringUpdateUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ + interface CoauthoringUpdateCollectionUpdateData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** 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] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * 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. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ + interface ConditionalStyleUpdateData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding?: number; + } + /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ + interface XmlMappingUpdateData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + } + /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ + interface CustomXmlPrefixMappingCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ + interface CustomXmlSchemaCollectionUpdateData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ + interface CustomXmlValidationErrorCollectionUpdateData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ + interface CustomXmlValidationErrorUpdateData { + /** + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + node?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ + interface CustomXmlNodeCollectionUpdateData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ + interface CustomXmlNodeUpdateData { + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: string; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + interface ContentControlUpdateData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + /** + * 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 date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + /** + * 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; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * 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] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + interface ContentControlListItemUpdateData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ + interface CustomXmlPartUpdateData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ + interface DocumentUpdateData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowUpdateData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * 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; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies whether grammatical errors are marked by a wavy green line in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areGrammaticalErrorsShown?: boolean; + /** + * Specifies whether to use the default math settings when creating new equations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areMathDefaultsUsed?: boolean; + /** + * Specifies whether to disable features introduced after a specified version. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areNewerFeaturesDisabled?: boolean; + /** + * Specifies whether Microsoft Word underlines spelling errors in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areSpellingErrorsShown?: boolean; + /** + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areStylesUpdatedOnOpen?: boolean; + /** + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areTrueTypeFontsEmbedded?: boolean; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + consecutiveHyphensLimit?: number; + /** + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultTabStop?: number; + /** + * Specifies the browser frame for displaying a webpage via hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultTargetFrame?: string; + /** + * Specifies whether Word should not embed common system fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + doNotEmbedSystemFonts?: boolean; + /** + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + encryptionProvider?: string; + /** + * Specifies the East Asian language used for line breaking. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + /** + * Specifies the line break control level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + /** + * Specifies whether Word shows the next heading level when the previous is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formattingIsNextLevelShown?: boolean; + /** + * Specifies whether to show user-defined styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formattingIsUserStyleNameShown?: boolean; + /** + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridDistanceHorizontal?: number; + /** + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridDistanceVertical?: number; + /** + * Specifies whether the character grid starts from the upper-left corner of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridIsOriginFromMargin?: boolean; + /** + * Specifies the horizontal origin point for the invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridOriginHorizontal?: number; + /** + * Specifies the vertical origin point for the invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridOriginVertical?: number; + /** + * Specifies the interval for horizontal character gridlines in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridSpaceBetweenHorizontalLines?: number; + /** + * Specifies the interval for vertical character gridlines in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gridSpaceBetweenVerticalLines?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies the width of the hyphenation zone, in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenationZone?: number; + /** + * Specifies whether automatic formatting options override formatting restrictions. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAutoFormatOverrideOn?: boolean; + /** + * Specifies whether charts in the active document use cell-reference data-point tracking. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isChartDataPointTracked?: boolean; + /** + * Specifies whether the compatibility option specified by the `type` property is enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isCompatible?: boolean; + /** + * Specifies whether the document is final. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFinal?: boolean; + /** + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFontsSubsetSaved?: boolean; + /** + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormsDataPrinted?: boolean; + /** + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormsDataSaved?: boolean; + /** + * Specifies whether a grammar check has been run on the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isGrammarChecked?: boolean; + /** + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isKerningByAlgorithm?: boolean; + /** + * Specifies whether to embed speech and handwriting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLinguisticDataEmbedded?: boolean; + /** + * Specifies whether Word optimizes the document for Word 97. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isOptimizedForWord97?: boolean; + /** + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isPostScriptPrintedOverText?: boolean; + /** + * Specifies whether users can change the Quick Style set. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isQuickStyleSetLocked?: boolean; + /** + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isReadOnlyRecommended?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSnappedToGrid?: boolean; + /** + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSnappedToShapes?: boolean; + /** + * Specifies whether spelling has been checked throughout the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSpellingChecked?: boolean; + /** + * Specifies whether formatting restrictions are enforced in a protected document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isStyleEnforced?: boolean; + /** + * Specifies whether users can change the document theme. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isThemeLocked?: boolean; + /** + * Specifies whether the document was created or opened by the user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isUserControl?: boolean; + /** + * Specifies the character spacing adjustment. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + /** + * Specifies the format type that Microsoft Word uses when automatically formatting the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + /** + * Specifies the kinsoku characters after which Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakAfter?: string; + /** + * Specifies the kinsoku characters before which Word will not break a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noLineBreakBefore?: string; + /** + * Sets a password that must be supplied to open the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + password?: string; + /** + * Specifies whether revision marks are printed with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + printRevisions?: boolean; + /** + * Specifies the width of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingLayoutSizeX?: number; + /** + * Specifies the height of pages in reading layout view when frozen. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingLayoutSizeY?: number; + /** + * Specifies whether pages in reading layout view are frozen for handwritten markup. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readingModeIsLayoutFrozen?: boolean; + /** + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + removePersonalInformationOnSave?: boolean; + /** + * Specifies the encoding used when saving the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies the encoding for saving as encoded text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; + /** + * Specifies how Word marks line and paragraph breaks in text files. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; + /** + * Specifies whether to track formatting changes when change tracking is on. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackFormatting?: boolean; + /** + * Specifies whether to mark moved text when Track Changes is on. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackMoves?: boolean; + /** + * Specifies whether changes are tracked in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackRevisions?: boolean; + /** + * Specifies whether to remove or store date and time metadata for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + trackedChangesAreDateAndTimeRemoved?: boolean; + /** + * Sets a password for saving changes to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + writePassword?: string; + /** + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlAreAdvancedErrorsShown?: boolean; + /** + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlIsXsltUsedWhenSaving?: boolean; + /** + * Specifies the path and file name for the XSLT to apply when saving a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlSaveThroughXSLT?: string; + } + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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({ ... })`. */ + interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** 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] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + interface FontUpdateData { + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fill?: Word.Interfaces.FillFormatUpdateData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + /** + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allCaps?: boolean; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + engrave?: boolean; + /** + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow?: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor?: string; + } + /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ + interface HeadingStyleUpdateData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + } + /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ + interface HeadingStyleCollectionUpdateData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + interface HyperlinkUpdateData { /** - * Specify the number of items in the queried collection to be included in the result. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $top?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * 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. + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $skip?: number; - } - /** An interface for updating data on the `Editor` object, for use in `editor.set({ ... })`. */ - interface EditorUpdateData { + address?: string; /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeUpdateData; + emailSubject?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ - interface ConflictCollectionUpdateData { - items?: Word.Interfaces.ConflictData[]; - } - /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ - interface ConflictUpdateData { + screenTip?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ - interface ApplicationUpdateData { + subAddress?: string; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + target?: string; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + textToDisplay?: string; } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - interface BodyUpdateData { + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + interface HyperlinkCollectionUpdateData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + interface InlinePictureUpdateData { /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontUpdateData; + altTextDescription?: string; /** - * 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. + * Specifies a string that contains the title for the inline image. * * @remarks * [Api set: WordApi 1.1] */ - style?: string; + altTextTitle?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ - interface BorderUpdateData { + height?: number; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - color?: string; + hyperlink?: string; /** - * Specifies the border type for the border. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + lockAspectRatio?: boolean; /** - * Specifies whether the border is visible. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - visible?: boolean; + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ + interface LinkFormatUpdateData { /** - * Specifies the width for the border. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ - interface BorderUniversalUpdateData { + isAutoUpdated?: boolean; /** - * Specifies the graphical page-border design for the document. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + isLocked?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + sourceFullName?: string; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + interface ListItemUpdateData { /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + interface ListLevelUpdateData { /** - * Specifies whether the border is visible. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isVisible?: boolean; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the line style of the border. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the line width of an object's border. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - interface BorderCollectionUpdateData { + linkedStyle?: string; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the number format for the specified list level. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderColor?: string; + numberFormat?: string; /** - * Specifies the border type of the inside borders. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + numberPosition?: number; /** - * Specifies the width of the inside borders. + * Specifies the number style for the list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderColor?: string; + resetOnHigher?: number; /** - * Specifies the border type of the outside borders. + * Specifies the starting number for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + startAt?: number; /** - * Specifies the width of the outside borders. + * Specifies the tab position for the specified list level object. * * @remarks * [Api set: WordApiDesktop 1.1] */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; } - /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ - interface BorderUniversalCollectionUpdateData { - items?: Word.Interfaces.BorderUniversalData[]; + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - interface BreakUpdateData { + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + interface ListTemplateUpdateData { /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; + /** 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] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * 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 `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ - interface BuildingBlockUpdateData { + /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ + interface OleFormatUpdateData { /** - * Specifies the description for the building block. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + classType?: string; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + iconIndex?: number; /** - * Specifies the name of the building block. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + iconLabel?: string; /** - * Specifies the contents of the building block. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - interface CheckboxContentControlUpdateData { + iconName?: string; /** - * Specifies the current state of the checkbox. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; + isFormattingPreservedOnUpdate?: boolean; } - /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ - interface CoauthoringLockUpdateData { + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ + interface WindowUpdateData { /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ - interface CoauthoringLockCollectionUpdateData { - items?: Word.Interfaces.CoauthoringLockData[]; - } - /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ - interface CoauthorCollectionUpdateData { - items?: Word.Interfaces.CoauthorData[]; - } - /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ - interface CoauthoringUpdateUpdateData { + next?: Word.Interfaces.WindowUpdateData; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ - interface CoauthoringUpdateCollectionUpdateData { - items?: Word.Interfaces.CoauthoringUpdateData[]; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - interface CommentUpdateData { + previous?: Word.Interfaces.WindowUpdateData; /** - * Specifies the comment's content range. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + areRulersDisplayed?: boolean; /** - * Specifies the comment's content as plain text. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + areThumbnailsDisplayed?: boolean; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - interface CommentCollectionUpdateData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - interface CommentContentRangeUpdateData { + caption?: string; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + horizontalPercentScrolled?: number; /** - * 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. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + isDocumentMapVisible?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ - interface CommentReplyUpdateData { + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the commentReply's content range. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + isLeftScrollBarDisplayed?: boolean; /** - * Gets the parent comment of this reply. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentComment?: Word.Interfaces.CommentUpdateData; + isRightRulerDisplayed?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; - } - /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - interface CommentReplyCollectionUpdateData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ - interface ConditionalStyleUpdateData { + isSplit?: boolean; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomPadding?: number; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: number; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * Specifies whether the window is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightPadding?: number; + isVisible?: boolean; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: number; - } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - interface XmlMappingUpdateData { + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies the vertical split percentage for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + splitVertical?: number; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies the width of the style area in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; - } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - interface CustomXmlPrefixMappingCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - interface CustomXmlSchemaCollectionUpdateData { - items?: Word.Interfaces.CustomXmlSchemaData[]; + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled?: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; } - /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - interface CustomXmlValidationErrorCollectionUpdateData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - interface CustomXmlValidationErrorUpdateData { + /** 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] + */ + 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] + */ + 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] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - interface CustomXmlNodeCollectionUpdateData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - interface CustomXmlNodeUpdateData { + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + leftIndent?: number; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + lineSpacing?: number; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + lineUnitAfter?: number; /** - * Gets the object representing the part associated with this node. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + lineUnitBefore?: number; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + outlineLevel?: number; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + rightIndent?: number; /** - * Specifies the value of the current node. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - nodeValue?: string; + spaceAfter?: number; /** - * Specifies the text for the current node. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - interface ContentControlUpdateData { + spaceBefore?: number; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the style name for the paragraph. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + style?: string; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + interface ParagraphFormatUpdateData { /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontUpdateData; + firstLineIndent?: number; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + keepTogether?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + keepWithNext?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + leftIndent?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + lineSpacing?: number; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + lineUnitAfter?: number; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotDelete?: boolean; + lineUnitBefore?: number; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotEdit?: boolean; + mirrorIndents?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - color?: string; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - placeholderText?: string; + rightIndent?: number; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - removeWhenEdited?: boolean; + spaceAfter?: number; /** - * Specifies the style name for the content control. 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. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - style?: string; + spaceBefore?: number; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + widowControl?: boolean; + } + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + interface RangeUpdateData { /** - * Specifies a tag to identify a content control. + * 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] */ - tag?: string; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the title for a content control. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - interface ContentControlListItemUpdateData { + listFormat?: Word.Interfaces.ListFormatUpdateData; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - interface ContentControlListItemCollectionUpdateData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - interface CustomPropertyUpdateData { + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - interface CustomXmlPartUpdateData { + combineCharacters?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - interface CustomXmlPartScopedCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - interface DocumentUpdateData { + end?: number; /** - * Gets the active window for the document. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowUpdateData; + fitTextWidth?: number; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + grammarChecked?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + hasNoProofing?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the properties of the document. + * 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. * * @remarks * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + hyperlink?: string; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + id?: string; /** - * Specifies if the edits in the document are automatically saved. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the ChangeTracking mode. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + languageDetected?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - interface DocumentCreatedUpdateData { + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + showAll?: boolean; /** - * Gets the properties of the document. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - interface DocumentPropertiesUpdateData { + spellingChecked?: boolean; /** - * Specifies the author of the document. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + start?: number; /** - * Specifies the category of the document. + * Specifies the style name for the range. 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. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - category?: string; + style?: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - comments?: string; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the company of the document. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: string; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + interface SearchOptionsUpdateData { /** - * Specifies the format of the document. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - format?: string; + ignorePunct?: boolean; /** - * Specifies the keywords of the document. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - keywords?: string; + ignoreSpace?: boolean; /** - * Specifies the manager of the document. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - manager?: string; + matchCase?: boolean; /** - * Specifies the subject of the document. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subject?: string; + matchPrefix?: boolean; /** - * Specifies the title of the document. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title?: string; - } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - interface FieldUpdateData { + matchSuffix?: boolean; /** - * Gets the field's result data. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeUpdateData; + matchWholeWord?: boolean; /** - * Specifies the field's code instruction. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: string; + matchWildcards?: boolean; + } + /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ + interface SectionUpdateData { /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: string; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Returns a `PageSetup` object that's associated with the section. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + pageSetup?: Word.Interfaces.PageSetupUpdateData; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies if the section is protected for forms. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - showCodes?: boolean; + protectedForForms?: boolean; } - /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ - interface FieldCollectionUpdateData { - items?: Word.Interfaces.FieldData[]; + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; } - /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ - interface FontUpdateData { + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + interface SettingUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - fill?: Word.Interfaces.FillFormatUpdateData; + value?: any; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + interface StyleUpdateData { /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - glow?: Word.Interfaces.GlowFormatUpdateData; + borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - line?: Word.Interfaces.LineFormatUpdateData; + font?: Word.Interfaces.FontUpdateData; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; + frame?: Word.Interfaces.FrameUpdateData; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatUpdateData; + linkStyle?: Word.Interfaces.StyleUpdateData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - allCaps?: boolean; + shading?: Word.Interfaces.ShadingUpdateData; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - bold?: boolean; + tableStyle?: Word.Interfaces.TableStyleUpdateData; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + automaticallyUpdate?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - color?: string; + baseStyle?: string; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + hasProofing?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + locked?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - doubleStrikeThrough?: boolean; + priority?: number; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emboss?: boolean; + quickStyle?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + unhideWhenUsed?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - engrave?: boolean; + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + interface ShadingUpdateData { /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - hidden?: boolean; + backgroundPatternColor?: string; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - highlightColor?: string; + foregroundPatternColor?: string; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + interface ShadingUniversalUpdateData { /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + backgroundPatternColor?: string; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + foregroundPatternColor?: string; /** - * Specifies a value that represents the name of the font. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + interface TableUpdateData { /** - * Specifies the font name in a right-to-left language document. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameBidirectional?: string; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the East Asian font name. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nameFarEast?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + description?: string; /** - * Specifies the number form setting for an OpenType font. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + headerRowCount?: number; /** - * Specifies the number spacing setting for the font. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - outline?: boolean; + shadingColor?: string; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the style name for the table. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - position?: number; + style?: string; /** - * Specifies the scaling percentage applied to the font. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - scaling?: number; + styleBandedColumns?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shadow?: boolean; + styleBandedRows?: boolean; /** - * Specifies a value that represents the font size in points. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sizeBidirectional?: number; + styleFirstColumn?: boolean; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - smallCaps?: boolean; + styleLastColumn?: boolean; /** - * Specifies the spacing between characters. + * Specifies whether the table has a total (last) row with a special style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleTotalRow?: boolean; + /** + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + title?: string; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + values?: string[][]; /** - * Specifies the stylistic set for the font. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - subscript?: boolean; + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + interface TableStyleUpdateData { /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - superscript?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + allowBreakAcrossPage?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - underlineColor?: string; - } - /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ - interface HeadingStyleUpdateData { + bottomCellMargin?: number; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * Specifies the spacing (in points) between the cells in a table style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + cellSpacing?: number; + /** + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: number; + columnStripe?: number; /** - * Specifies the name of style for a heading. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ - interface HeadingStyleCollectionUpdateData { - items?: Word.Interfaces.HeadingStyleData[]; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - interface HyperlinkUpdateData { + isBreakAcrossPagesAllowed?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Specifies the amount of space to add between the contents and the left borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + leftCellMargin?: number; + /** + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + leftIndent?: number; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the amount of space to add between the contents and the right borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + rightCellMargin?: number; + /** + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + rowStripe?: number; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the amount of space to add between the contents and the top borders of the cells. + * + * @remarks + * [Api set: WordApi 1.6] + */ + topCellMargin?: number; + } + /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ + interface TabStopCollectionUpdateData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + interface TableColumnUpdateData { + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: string; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: string; + preferredWidth?: number; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: string; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; + width?: number; } - /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ - interface HyperlinkCollectionUpdateData { - items?: Word.Interfaces.HyperlinkData[]; + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + interface TableColumnCollectionUpdateData { + items?: Word.Interfaces.TableColumnData[]; } - /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ - interface InlinePictureUpdateData { + /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ + interface TableOfAuthoritiesUpdateData { /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + bookmark?: string; /** - * Specifies a string that contains the title for the inline image. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: string; + category?: number; /** - * Specifies a number that describes the height of the inline image. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + entrySeparator?: string; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + isCategoryHeaderIncluded?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ - interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ - interface LinkFormatUpdateData { + isPassimUsed?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + pageNumberSeparator?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + pageRangeSeparator?: string; /** - * Specifies if the linked picture is saved with the document. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + sequenceName?: string; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: string; - } - /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ - interface ListCollectionUpdateData { - items?: Word.Interfaces.ListData[]; - } - /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ - interface ListItemUpdateData { + sequenceSeparator?: string; /** - * Specifies the level of the item in the list. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; } - /** 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] - */ - font?: Word.Interfaces.FontUpdateData; + /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ + interface TableOfAuthoritiesCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ + interface TableOfAuthoritiesCategoryCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ + interface TableOfContentsUpdateData { /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + areFieldsUsed?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the number style for the list level object. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + arePageNumbersIncluded?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + lowerHeadingLevel?: number; /** - * Specifies the tab position for the specified list level object. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + tableId?: string; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + upperHeadingLevel?: number; } - /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; + /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ + interface TableOfContentsCollectionUpdateData { + items?: Word.Interfaces.TableOfContentsData[]; } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - interface ListTemplateUpdateData { + /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ + interface TableOfFiguresUpdateData { /** - * Specifies the name of the list template. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies whether the list template is outline numbered. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - interface NoteItemUpdateData { + areFieldsUsed?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + areHyperlinksUsedOnWeb?: boolean; /** - * Represents a footnote or endnote reference in the main document. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ - interface OleFormatUpdateData { + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + arePageNumbersIncluded?: boolean; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel?: string; + captionLabel?: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: string; + isLabelIncluded?: boolean; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate?: boolean; - } - /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ - interface PageCollectionUpdateData { - items?: Word.Interfaces.PageData[]; - } - /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ - interface PaneCollectionUpdateData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ - interface WindowUpdateData { + lowerHeadingLevel?: number; /** - * Gets the next document window in the collection of open document windows. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.WindowUpdateData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the previous document window in the collection open document windows. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.WindowUpdateData; + tableId?: string; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ + interface TableOfFiguresCollectionUpdateData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + interface TableRowUpdateData { /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areThumbnailsDisplayed?: boolean; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - caption?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - horizontalPercentScrolled?: number; + preferredHeight?: number; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + shadingColor?: string; /** - * Specifies whether the document map is visible. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDocumentMapVisible?: boolean; + values?: string[][]; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isEnvelopeVisible?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + interface TableCellUpdateData { /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isHorizontalScrollBarDisplayed?: boolean; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isLeftScrollBarDisplayed?: boolean; + columnWidth?: number; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isRightRulerDisplayed?: boolean; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the window is split into multiple panes. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isSplit?: boolean; + shadingColor?: string; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalRulerDisplayed?: boolean; + value?: string; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + interface TableBorderUpdateData { /** - * Specifies whether the window is visible. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + color?: string; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Specifies the vertical split percentage for the window. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * + * @remarks + * [Api set: WordApi 1.3] + */ + width?: number; + } + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + interface TemplateUpdateData { + /** + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical?: number; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the width of the style area in points. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + hasNoProofing?: boolean; /** - * Specifies the state of the document window or task window. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; - } - /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ - interface WindowCollectionUpdateData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ - interface ParagraphUpdateData { + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + kerningByAlgorithm?: boolean; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemUpdateData; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * 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}. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + noLineBreakAfter?: string; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + noLineBreakBefore?: string; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + saved?: boolean; + } + /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ + interface TemplateCollectionUpdateData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ + interface ViewUpdateData { /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + areBackgroundsDisplayed?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + areCommentsDisplayed?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + areEditableRangesShaded?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + areFieldCodesDisplayed?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + areFormatChangesDisplayed?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the style name for the paragraph. 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. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ - interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - interface ParagraphFormatUpdateData { + areOtherAuthorsVisible?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + areTableGridlinesDisplayed?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + isDraft?: boolean; /** - * Specifies the left indent. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + isFormatDisplayed?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + isFullScreen?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + isInConflictMode?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + isInPanning?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Specifies whether the document is being viewed in reading layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + isInReadingLayout?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + isMailMergeDataView?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + isMainTextLayerVisible?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + isPointerShownAsMagnifier?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; - } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - interface RangeUpdateData { + isReadingLayoutActualView?: boolean; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies whether XML tags are visible in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + isXmlMarkupVisible?: boolean; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the character width of the range. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies if the range contains combined characters. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + revisionsBalloonWidth?: number; /** - * Specifies the ending character position of the range. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { /** - * Specifies the formatting for horizontal text set within vertical text. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + body?: Word.Interfaces.BodyUpdateData; /** - * 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. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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] + * [Api set: WordApiDesktop 1.2] */ - hyperlink?: string; + canvas?: Word.Interfaces.CanvasUpdateData; /** - * Specifies the ID for the range. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - id?: string; + fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageDetected?: boolean; + parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Specifies an East Asian language for the range. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - showAll?: boolean; + allowOverlap?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spellingChecked?: boolean; + altTextDescription?: string; /** - * Specifies the starting character position of the range. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - start?: number; + geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies the style name for the range. 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. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + height?: number; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + heightRelative?: number; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; - } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - interface SearchOptionsUpdateData { + left?: number; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - ignorePunct?: boolean; + leftRelative?: number; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - ignoreSpace?: boolean; + lockAspectRatio?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchCase?: boolean; + name?: string; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchPrefix?: boolean; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchSuffix?: boolean; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWholeWord?: boolean; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - matchWildcards?: boolean; - } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - interface SectionUpdateData { + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyUpdateData; + rotation?: number; /** - * Returns a `PageSetup` object that's associated with the section. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + top?: number; /** - * Specifies if the section is protected for forms. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - protectedForForms?: boolean; - } - /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ - interface SectionCollectionUpdateData { - items?: Word.Interfaces.SectionData[]; + topRelative?: number; + /** + * Specifies if the shape is visible. Not applicable to inline shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + visible?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; } - /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ - interface SettingUpdateData { + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + interface ShapeGroupUpdateData { /** - * Specifies the value of the setting. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - value?: any; + shape?: Word.Interfaces.ShapeUpdateData; } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + interface CanvasUpdateData { + /** + * Gets the Shape object associated with the canvas. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shape?: Word.Interfaces.ShapeUpdateData; } - /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - interface StyleUpdateData { + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + interface ShapeFillUpdateData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + backgroundColor?: string; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + foregroundColor?: string; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - frame?: Word.Interfaces.FrameUpdateData; + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + interface TextFrameUpdateData { /** - * Specifies a link between a paragraph and a character style. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - linkStyle?: Word.Interfaces.StyleUpdateData; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + bottomMargin?: number; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + leftMargin?: number; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingUpdateData; + noTextRotation?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies whether the style is automatically redefined based on the selection. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - automaticallyUpdate?: boolean; + rightMargin?: number; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - baseStyle?: string; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasProofing?: boolean; + wordWrap?: boolean; + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + interface ShapeTextWrapUpdateData { /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + bottomDistance?: number; /** - * Specifies an East Asian language for the style. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + leftDistance?: number; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - locked?: boolean; + rightDistance?: number; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + /** + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: string; + topDistance?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + interface ReviewerUpdateData { + /** + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + isVisible?: boolean; + } + /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + interface RevisionsFilterUpdateData { /** - * Specifies the priority. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: number; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + interface RepeatingSectionItemUpdateData { /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ + interface RevisionUpdateData { /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - interface ShadingUpdateData { + movedRange?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ + interface RevisionCollectionUpdateData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + interface DatePickerContentControlUpdateData { /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ - interface ShadingUniversalUpdateData { + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + color?: string; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - interface TableUpdateData { + dateDisplayFormat?: string; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the description of the table. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isTemporary?: boolean; /** - * Specifies the number of header rows. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + lockContentControl?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lockContents?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + tag?: string; /** - * Specifies the style name for the table. 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. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + interface PictureContentControlUpdateData { /** - * Specifies whether the table has banded columns. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies whether the table has banded rows. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether the table has a first column with a special style. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether the table has a last column with a special style. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + color?: string; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + isTemporary?: boolean; /** - * Specifies the title of the table. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + lockContentControl?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + lockContents?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + tag?: string; /** - * Specifies the width of the table in points. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + title?: string; } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - interface TableStyleUpdateData { + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + interface GroupContentControlUpdateData { /** - * Specifies the table's alignment against the page margin. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnStripe?: number; + color?: string; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isBreakAcrossPagesAllowed?: boolean; + isTemporary?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + lockContentControl?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftIndent?: number; + lockContents?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + tag?: string; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe?: number; + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + interface BuildingBlockGalleryContentControlUpdateData { /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ - interface TabStopCollectionUpdateData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; - } - /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ - interface TableColumnUpdateData { + range?: Word.Interfaces.RangeUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + buildingBlockCategory?: string; /** - * Specifies the width of the column, in points. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ - interface TableOfAuthoritiesUpdateData { + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark?: string; + color?: string; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: number; + isTemporary?: boolean; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entrySeparator?: string; + lockContentControl?: boolean; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCategoryHeaderIncluded?: boolean; + lockContents?: boolean; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEntryFormattingKept?: boolean; + tag?: string; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPassimUsed?: boolean; + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + interface RepeatingSectionContentControlUpdateData { /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName?: string; + xmlapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator?: string; + allowInsertDeleteSection?: boolean; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ - interface TableOfAuthoritiesCollectionUpdateData { - items?: Word.Interfaces.TableOfAuthoritiesData[]; - } - /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ - interface TableOfAuthoritiesCategoryCollectionUpdateData { - items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; - } - /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ - interface TableOfContentsUpdateData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + color?: string; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + isTemporary?: boolean; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + lockContentControl?: boolean; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + lockContents?: boolean; /** - * Specifies whether page numbers are included in the table of contents. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + tag?: string; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + title?: string; + } + /** An interface for updating data on the `ReadabilityStatisticCollection` object, for use in `readabilityStatisticCollection.set({ ... })`. */ + interface ReadabilityStatisticCollectionUpdateData { + items?: Word.Interfaces.ReadabilityStatisticData[]; + } + /** An interface for updating data on the `WebSettings` object, for use in `webSettings.set({ ... })`. */ + interface WebSettingsUpdateData { /** - * Specifies the character between entries and their page numbers in the table of contents. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + allowPng?: boolean; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ - interface TableOfContentsCollectionUpdateData { - items?: Word.Interfaces.TableOfContentsData[]; - } - /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ - interface TableOfFiguresUpdateData { + organizeInFolder?: boolean; /** - * Specifies whether built-in heading styles are used for the table of figures. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + pixelsPerInch?: number; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + relyOnCSS?: boolean; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Specifies whether page numbers are included in the table of figures. + * Specifies the target browser for documents viewed in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + useLongFileNames?: boolean; + } + /** An interface for updating data on the `XmlNodeCollection` object, for use in `xmlNodeCollection.set({ ... })`. */ + interface XmlNodeCollectionUpdateData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface for updating data on the `XmlNode` object, for use in `xmlNode.set({ ... })`. */ + interface XmlNodeUpdateData { /** - * Specifies the label that identifies the items to be included in the table of figures. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - captionLabel?: string; + nodeValue?: string; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLabelIncluded?: boolean; + placeholderText?: string; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + text?: string; + } + /** An interface for updating data on the `HtmlDivision` object, for use in `htmlDivision.set({ ... })`. */ + interface HtmlDivisionUpdateData { /** - * Specifies the character between entries and their page numbers in the table of figures. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + leftIndent?: number; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + rightIndent?: number; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ - interface TableOfFiguresCollectionUpdateData { - items?: Word.Interfaces.TableOfFiguresData[]; - } - /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - interface TableRowUpdateData { + spaceAfter?: number; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the spacing (in points) before this HTML division. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + spaceBefore?: number; + } + /** An interface for updating data on the `HtmlDivisionCollection` object, for use in `htmlDivisionCollection.set({ ... })`. */ + interface HtmlDivisionCollectionUpdateData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + interface FrameUpdateData { /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the preferred height of the row in points. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + height?: number; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ - interface TableRowCollectionUpdateData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ - interface TableCellUpdateData { + horizontalDistanceFromText?: number; /** - * Gets the body object of the cell. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + horizontalPosition?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + lockAnchor?: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the text of the cell. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + textWrap?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - interface TableBorderUpdateData { + verticalDistanceFromText?: number; /** - * Specifies the table border color. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + verticalPosition?: number; /** - * Specifies the type of the table border. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + width?: number; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; } - /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ - interface TemplateUpdateData { + /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ + interface FrameCollectionUpdateData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ + interface DocumentLibraryVersionCollectionUpdateData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ + interface ListFormatUpdateData { /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Specifies the line break control level for the document. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + listLevelNumber?: number; + } + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + interface FillFormatUpdateData { /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the character spacing adjustment for the template. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + gradientAngle?: number; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + rotateWithObject?: boolean; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + textureHorizontalScale?: number; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ - interface ViewUpdateData { + textureOffsetX?: number; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + textureOffsetY?: number; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + textureTile?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + textureVerticalScale?: number; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + interface GlowFormatUpdateData { /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + color?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether field codes are displayed. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + radius?: number; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + interface LineFormatUpdateData { /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies whether table gridlines are displayed. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the column width in Reading mode. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies whether the window is in full-screen view. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + insetPen?: boolean; /** - * Specifies whether the document is in conflict mode view. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + isVisible?: boolean; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + transparency?: number; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + interface ReflectionFormatUpdateData { /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + blur?: number; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + offset?: number; /** - * Specifies whether XML tags are visible in the document. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + size?: number; /** - * Specifies the display mode for tracked changes. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + transparency?: number; /** - * Specifies the page color in Reading mode. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ + interface ColorFormatUpdateData { /** - * Specifies the page movement type. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + brightness?: number; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies the width of the revision balloons. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + rgb?: string; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + interface ShadowFormatUpdateData { /** - * Specifies the document element displayed in print layout view. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the active window pane. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + blur?: number; /** - * Specifies the view type. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - interface ShapeUpdateData { + isVisible?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + obscured?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasUpdateData; + offsetX?: number; /** - * Returns the fill formatting of the shape. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillUpdateData; + offsetY?: number; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + rotateWithShape?: boolean; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + size?: number; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Gets the text frame object of the shape. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + transparency?: number; /** - * Returns the text wrap formatting of the shape. + * Specifies the shape shadow type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + interface ThreeDimensionalFormatUpdateData { /** - * Specifies whether a given shape can overlap other shapes. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies a string that represents the alternative text associated with the shape. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the depth of the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + bevelBottomDepth?: number; /** - * The height, in points, of the shape. + * Specifies the inset size for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + bevelBottomInset?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the depth of the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + bevelTopDepth?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the inset size for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + bevelTopInset?: number; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * The name of the shape. + * Specifies the width of the contour of a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + contourWidth?: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the depth of the shape's extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + depth?: number; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the amount of perspective for a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + fieldOfView?: number; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + isPerspective?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + isVisible?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the angle of the lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + lightAngle?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the position of the light source relative to the extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * The width, in points, of the shape. + * Specifies the intensity of the extrusion lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the extrusion surface material. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - interface ShapeGroupUpdateData { + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets the Shape object associated with the group. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - interface CanvasUpdateData { + projectText?: boolean; /** - * Gets the Shape object associated with the canvas. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - interface ShapeCollectionUpdateData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - interface ShapeFillUpdateData { + rotationX?: number; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + rotationY?: number; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the z-axis rotation of the camera. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + rotationZ?: number; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies the position on the z-axis for the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + z?: number; } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - interface TextFrameUpdateData { + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + interface BibliographyUpdateData { /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies the name of the active style to use for the bibliography. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + bibliographyStyle?: string; + } + /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ + interface SourceCollectionUpdateData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + interface PageSetupUpdateData { /** - * Represents the bottom margin, in points, of the text frame. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** - * Represents the left margin, in points, of the text frame. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + bookFoldPrinting?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + bookFoldPrintingSheets?: number; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + bookFoldReversePrinting?: boolean; /** - * Represents the right margin, in points, of the text frame. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + bottomMargin?: number; /** - * Represents the top margin, in points, of the text frame. + * Specifies the number of characters per line in the document grid. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + charsLine?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether the first page has a different header and footer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + differentFirstPageHeaderFooter?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - interface ShapeTextWrapUpdateData { + footerDistance?: number; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + gutter?: number; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + headerDistance?: number; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ - interface ReviewerUpdateData { + leftMargin?: number; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ - interface ReviewerCollectionUpdateData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ - interface RevisionsFilterUpdateData { + linesPage?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + mirrorMargins?: boolean; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ - interface RepeatingSectionItemUpdateData { + oddAndEvenPagesHeaderFooter?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ - interface RevisionUpdateData { + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedRange?: Word.Interfaces.RangeUpdateData; + pageHeight?: number; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ - interface RevisionCollectionUpdateData { - items?: Word.Interfaces.RevisionData[]; - } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - interface DatePickerContentControlUpdateData { + pageWidth?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + rightMargin?: number; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the appearance of the content control. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + showGrid?: boolean; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + suppressEndnotes?: boolean; /** - * Specifies the format in which dates are displayed. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + topMargin?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + twoPagesOnOne?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ + interface LineNumberingUpdateData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + countBy?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + distanceFromText?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + isActive?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the title for the content control. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + startingNumber?: number; } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - interface PictureContentControlUpdateData { + /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ + interface TextColumnCollectionUpdateData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ + interface TextColumnUpdateData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + spaceAfter?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + width?: number; + } + /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ + interface SelectionUpdateData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + end?: number; /** - * Specifies the appearance of the content control. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + fitTextWidth?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + isColumnSelectModeActive?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + isExtendModeActive?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + isStartActive?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + languageDetected?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the title for the content control. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - interface GroupContentControlUpdateData { + start?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + text?: string; + } + /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ + interface RangeScopedCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + interface BookmarkUpdateData { /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -150568,7528 +158487,7706 @@ declare namespace Word { */ range?: Word.Interfaces.RangeUpdateData; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + end?: number; /** - * Specifies the appearance of the content control. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + start?: number; + } + /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ + interface BookmarkCollectionUpdateData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ + interface IndexUpdateData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ + interface IndexCollectionUpdateData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ + interface ListTemplateCollectionUpdateData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ + interface ListTemplateGalleryCollectionUpdateData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** An interface describing the data returned by calling `editor.toJSON()`. */ + interface EditorData { /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + nextRange?: Word.Interfaces.RangeData; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies a tag to identify the content control. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + id?: string; /** - * Specifies the title for the content control. + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + name?: string; } - /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - interface BuildingBlockGalleryContentControlUpdateData { + /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ + interface ConflictCollectionData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface describing the data returned by calling `conflict.toJSON()`. */ + interface ConflictData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + range?: Word.Interfaces.RangeData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + interface CritiqueAnnotationData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + interface AnnotationData { /** - * Specifies the appearance of the content control. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + id?: string; /** - * Specifies the category for the building block content control. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - buildingBlockCategory?: string; + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; + } + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + interface ApplicationData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + checkLanguage?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + } + /** An interface describing the data returned by calling `body.toJSON()`. */ + interface BodyData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the collection of rich text content control objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lockContents?: boolean; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies a tag to identify the content control. + * Gets the collection of field objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tag?: string; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the title for the content control. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - title?: string; + 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] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * 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. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * 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 shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - interface RepeatingSectionContentControlUpdateData { + /** An interface describing the data returned by calling `border.toJSON()`. */ + interface BorderData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + color?: string; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - range?: Word.Interfaces.RangeUpdateData; + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + interface BorderUniversalData { + /** + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + artWidth?: number; /** - * Specifies the appearance of the content control. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + color?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + inside?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + isVisible?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ + interface BorderUniversalCollectionData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface describing the data returned by calling `break.toJSON()`. */ + interface BreakData { /** - * Specifies a tag to identify the content control. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies the title for the content control. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + pageIndex?: number; } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - interface FrameUpdateData { + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + interface BuildingBlockData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + description?: string; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + id?: string; /** - * Specifies the height (in points) of the frame. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + index?: number; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + name?: string; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + interface BuildingBlockCategoryData { /** - * Specifies if the frame is locked. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + index?: number; /** - * Specifies the relative horizontal position of the frame. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + name?: string; + } + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + interface BuildingBlockTypeItemData { /** - * Specifies the relative vertical position of the frame. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + index?: number; /** - * Specifies if document text wraps around the frame. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + interface CheckboxContentControlData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - verticalDistanceFromText?: number; + isChecked?: boolean; + } + /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ + interface CoauthoringLockData { /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + owner?: Word.Interfaces.CoauthorData; /** - * Specifies the width (in points) of the frame. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies the rule used to determine the width of the frame. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ - interface FrameCollectionUpdateData { - items?: Word.Interfaces.FrameData[]; + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; } - /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ - interface DocumentLibraryVersionCollectionUpdateData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; + /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ + interface CoauthoringLockCollectionData { + items?: Word.Interfaces.CoauthoringLockData[]; } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - interface ListFormatUpdateData { + /** An interface describing the data returned by calling `coauthor.toJSON()`. */ + interface CoauthorData { /** - * Gets the list template associated with the `ListFormat` object. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; - } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - interface FillFormatUpdateData { + emailAddress?: string; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + id?: string; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + isMe?: boolean; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + name?: string; + } + /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ + interface CoauthorCollectionData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ + interface CoauthoringData { /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + authors?: Word.Interfaces.CoauthorData[]; /** - * Specifies whether the fill rotates with the shape. + * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + me?: Word.Interfaces.CoauthorData; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + updates?: Word.Interfaces.CoauthoringUpdateData[]; /** - * Specifies the vertical offset of the texture. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + canCoauthor?: boolean; /** - * Specifies whether the texture is tiled. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + canMerge?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + pendingUpdates?: boolean; + } + /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ + interface CoauthoringUpdateData { /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + range?: Word.Interfaces.RangeData; } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - interface GlowFormatUpdateData { + /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ + interface CoauthoringUpdateCollectionData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: Word.Interfaces.ColorFormatUpdateData; + contentRange?: Word.Interfaces.CommentContentRangeData; /** - * Specifies the length of the radius for a glow effect. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - radius?: number; + replies?: Word.Interfaces.CommentReplyData[]; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - interface LineFormatUpdateData { + authorEmail?: string; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + authorName?: string; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + content?: string; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + creationDate?: Date; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + id?: string; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + resolved?: boolean; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + interface CommentContentRangeData { /** - * Specifies the dash style for the line. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + bold?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + hyperlink?: string; /** - * Specifies the style of the arrowhead at the end of the line. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + isEmpty?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + italic?: boolean; /** - * Specifies if to draw lines inside a shape. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - insetPen?: boolean; + strikeThrough?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isVisible?: boolean; + text?: string; /** - * Specifies the pattern applied to the line. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + interface CommentReplyData { /** - * Specifies the line format style. + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + authorEmail?: string; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - transparency?: number; + authorName?: string; /** - * Specifies the thickness of the line in points. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - weight?: number; - } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - interface ReflectionFormatUpdateData { + content?: string; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - blur?: number; + creationDate?: Date; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - offset?: number; + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ + interface ConditionalStyleData { /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + bottomPadding?: number; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + leftPadding?: number; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - interface ColorFormatUpdateData { + rightPadding?: number; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: number; + topPadding?: number; + } + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + interface XmlMappingData { /** - * Specifies the theme color for a color format. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + customXmlPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - interface ShadowFormatUpdateData { + isMapped?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + prefixMappings?: string; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + xpath?: string; + } + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + interface CustomXmlPrefixMappingCollectionData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + interface CustomXmlPrefixMappingData { /** - * Specifies whether the object or the formatting applied to it is visible. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + namespaceUri?: string; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + interface CustomXmlSchemaData { /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + location?: string; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + interface CustomXmlSchemaCollectionData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ + interface CustomXmlValidationErrorCollectionData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + interface CustomXmlValidationErrorData { /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + node?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the width of the shadow. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + errorCode?: number; /** - * Specifies the type of shadow formatting to apply to a shape. + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + name?: string; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + text?: string; /** - * Specifies the shape shadow type. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; } - /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ - interface ThreeDimensionalFormatUpdateData { + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + interface CustomXmlNodeCollectionData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + interface CustomXmlNodeData { /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the depth of the bottom bevel. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: number; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the inset size for the bottom bevel. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the depth of the top bevel. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the inset size for the top bevel. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + previousSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the width of the contour of a shape. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + baseName?: string; /** - * Specifies the depth of the shape's extrusion. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + namespaceUri?: string; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Specifies the amount of perspective for a shape. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + nodeValue?: string; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + text?: string; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + xpath?: string; /** - * Specifies the angle of the lighting. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + interface ContentControlData { /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Specifies the position of the light source relative to the extrusion. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Specifies the intensity of the extrusion lighting. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Specifies the extrusion surface material. + * Gets the collection of content control objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - rotationX?: number; + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Gets the collection of field objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - rotationY?: number; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the z-axis rotation of the camera. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationZ?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the position on the z-axis for the shape. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - interface BibliographyUpdateData { + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bibliographyStyle?: string; - } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; - } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - interface PageSetupUpdateData { + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * Gets the collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + lists?: Word.Interfaces.ListData[]; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Gets the collection of paragraph objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [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. */ - bookFoldPrinting?: boolean; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies the number of pages for each booklet. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets the collection of table objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bottomMargin?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies the number of characters per line in the document grid. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether the first page has a different header and footer. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - differentFirstPageHeaderFooter?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - footerDistance?: number; + cannotDelete?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutter?: number; + cannotEdit?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + color?: string; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + id?: number; /** - * Specifies the distance between the header and the top of the page in points. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - headerDistance?: number; + placeholderText?: string; /** - * Specifies the layout mode for the current document. + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + removeWhenEdited?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Specifies the style name for the content control. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - leftMargin?: number; + style?: string; /** - * Specifies the number of lines per page in the document grid. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linesPage?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - mirrorMargins?: boolean; + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; /** - * Specifies whether odd and even pages have different headers and footers. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - oddAndEvenPagesHeaderFooter?: boolean; + tag?: string; /** - * Specifies the orientation of the page. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + text?: string; /** - * Specifies the page height in points. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageHeight?: number; + title?: string; /** - * Specifies the page width in points. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageWidth?: number; + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + } + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + interface ContentControlListItemData { /** - * Specifies the paper size of the page. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + displayText?: string; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - rightMargin?: number; + index?: number; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + value?: string; + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + interface CustomPropertyData { /** - * Specifies the type of section break for the specified object. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + key?: string; /** - * Specifies whether to show the grid. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showGrid?: boolean; + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - suppressEndnotes?: boolean; + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + interface CustomXmlPartData { /** - * Specifies the top margin of the page in points. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin?: number; + documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies whether to print two pages per sheet. + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne?: boolean; + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - interface LineNumberingUpdateData { + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies the numeric increment for line numbers. + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: number; + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + builtIn?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isActive?: boolean; + id?: string; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + namespaceUri?: string; /** - * Specifies the starting line number. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: number; + xml?: string; } - /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ - interface TextColumnCollectionUpdateData { - items?: Word.Interfaces.TextColumnData[]; + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; } - /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ - interface TextColumnUpdateData { + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + interface DocumentData { /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - spaceAfter?: number; + activeWindow?: Word.Interfaces.WindowData; /** - * Specifies the width, in points, of the specified text columns. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ - interface SelectionUpdateData { + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the ending character position of the selection. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - end?: number; + body?: Word.Interfaces.BodyData; /** - * Specifies the width in which Word fits the text in the current selection. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + coauthoring?: Word.Interfaces.CoauthoringData; /** - * Specifies whether column selection mode is active. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isColumnSelectModeActive?: boolean; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies whether Extend mode is active. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isExtendModeActive?: boolean; + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Specifies whether the beginning of the selection is active. + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive?: boolean; + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Specifies whether Word has detected the language of the selected text. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the orientation of text in the selection. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the starting character position of the selection. + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + listTemplates?: Word.Interfaces.ListTemplateData[]; /** - * Specifies the text in the selection. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; - } - /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ - interface RangeScopedCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ - interface BookmarkUpdateData { + pageSetup?: Word.Interfaces.PageSetupData; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + properties?: Word.Interfaces.DocumentPropertiesData; /** - * Specifies the ending character position of the bookmark. + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + selection?: Word.Interfaces.SelectionData; /** - * Specifies the starting character position of the bookmark. + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Gets the collection of `Word.Window` objects for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + windows?: Word.Interfaces.WindowData[]; + /** + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; - } - /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ - interface BookmarkCollectionUpdateData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ - interface IndexUpdateData { + activeTheme?: string; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Gets the display name of the active theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + activeThemeDisplayName?: string; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ - interface IndexCollectionUpdateData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ - interface ListTemplateCollectionUpdateData { - items?: Word.Interfaces.ListTemplateData[]; - } - /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ - interface ListTemplateGalleryCollectionUpdateData { - items?: Word.Interfaces.ListTemplateGalleryData[]; - } - /** An interface describing the data returned by calling `editor.toJSON()`. */ - interface EditorData { + areFilePropertiesPasswordEncrypted?: boolean; /** - * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeData; + areGrammaticalErrorsShown?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Specifies whether to use the default math settings when creating new equations. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + areMathDefaultsUsed?: boolean; /** - * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * Specifies whether to disable features introduced after a specified version. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + areNewerFeaturesDisabled?: boolean; /** - * Gets the name of the editor. + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ - interface ConflictCollectionData { - items?: Word.Interfaces.ConflictData[]; - } - /** An interface describing the data returned by calling `conflict.toJSON()`. */ - interface ConflictData { + areSpellingErrorsShown?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + areStylesUpdatedOnOpen?: boolean; /** - * Gets the `RevisionType` for the `Conflict` object. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - interface CritiqueAnnotationData { + areTrueTypeFontsEmbedded?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - interface AnnotationData { + autoHyphenation?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + autoSaveOn?: boolean; /** - * Gets the state of the annotation. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.7] - */ - state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; - } - /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ - interface AnnotationCollectionData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface describing the data returned by calling `application.toJSON()`. */ - interface ApplicationData { + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Gets the code name for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + codeName?: string; /** - * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; + compatibilityMode?: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current"; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + consecutiveHyphensLimit?: number; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Gets a random number that Word assigns to changes in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - } - /** An interface describing the data returned by calling `body.toJSON()`. */ - interface BodyData { + currentRsid?: number; /** - * Gets the collection of rich text content control objects in the body. + * Specifies the interval (in points) between the default tab stops in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + defaultTabStop?: number; /** - * Gets the collection of field objects in the body. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + defaultTargetFrame?: string; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + doNotEmbedSystemFonts?: boolean; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + encryptionProvider?: string; /** - * Gets the collection of list objects in the body. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lists?: Word.Interfaces.ListData[]; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the collection of paragraph objects in the body. + * Specifies the line break control level. * * @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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * 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 shapes, groups, pictures, and canvases. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + formattingIsNextLevelShown?: boolean; /** - * Gets the collection of table objects in the body. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + formattingIsUserStyleNameShown?: boolean; /** - * 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. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + fullName?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + gridDistanceHorizontal?: number; /** - * Gets the text of the body. Use the insertText method to insert text. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + gridDistanceVertical?: number; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 { + gridIsOriginFromMargin?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + gridOriginHorizontal?: number; /** - * Gets the location of the border. + * Specifies the vertical origin point for the invisible grid. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + gridOriginVertical?: number; /** - * Specifies the border type for the border. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + gridSpaceBetweenHorizontalLines?: number; /** - * Specifies whether the border is visible. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + gridSpaceBetweenVerticalLines?: number; /** - * Specifies the width for the border. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ - interface BorderUniversalData { + hasPassword?: boolean; /** - * Specifies the graphical page-border design for the document. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + hasVbProject?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + hyphenateCaps?: boolean; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the width of the hyphenation zone, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + hyphenationZone?: number; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + isAutoFormatOverrideOn?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + isChartDataPointTracked?: boolean; /** - * Specifies whether the border is visible. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + isCompatible?: boolean; /** - * Specifies the line style of the border. + * Specifies whether the document is final. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + isFinal?: boolean; /** - * Specifies the line width of an object's border. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ - interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ - interface BorderUniversalCollectionData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - interface BreakData { + isFontsSubsetSaved?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isFormsDataPrinted?: boolean; /** - * Returns the page number on which the break occurs. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: number; - } - /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ - interface BreakCollectionData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ - interface BuildingBlockData { + isFormsDataSaved?: boolean; /** - * Specifies the description for the building block. + * Specifies whether a grammar check has been run on the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isGrammarChecked?: boolean; /** - * Returns the internal identification number for the building block. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isInAutoSave?: boolean; /** - * Returns the position of this building block in a collection. + * Gets whether the document is in form design mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isInFormsDesign?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies whether Word kerns half-width Latin characters and punctuation marks. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + isKerningByAlgorithm?: boolean; /** - * Specifies the name of the building block. + * Specifies whether to embed speech and handwriting data. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + isLinguisticDataEmbedded?: boolean; /** - * Specifies the contents of the building block. + * Gets whether this document is a master document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - interface BuildingBlockCategoryData { + isMasterDocument?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies whether Word optimizes the document for Word 97. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isOptimizedForWord97?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - interface BuildingBlockTypeItemData { + isPostScriptPrintedOverText?: boolean; /** - * Returns the position of an item in a collection. + * Specifies whether users can change the Quick Style set. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + isQuickStyleSetLocked?: boolean; /** - * Returns the localized name of a building block type. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ - interface CheckboxContentControlData { + isReadOnly?: boolean; /** - * Specifies the current state of the checkbox. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; - } - /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ - interface CoauthoringLockData { + isReadOnlyRecommended?: boolean; /** - * Gets the owner of the lock. + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorData; + isSnappedToGrid?: boolean; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isSnappedToShapes?: boolean; /** - * Gets a `CoauthoringLockType` value that represents the lock type. + * Specifies whether spelling has been checked throughout the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; - } - /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ - interface CoauthoringLockCollectionData { - items?: Word.Interfaces.CoauthoringLockData[]; - } - /** An interface describing the data returned by calling `coauthor.toJSON()`. */ - interface CoauthorData { + isSpellingChecked?: boolean; /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locks?: Word.Interfaces.CoauthoringLockData[]; + isStyleEnforced?: boolean; /** - * Gets the email address of the coauthor. + * Gets whether this document is a subdocument of a master document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: string; + isSubdocument?: boolean; /** - * Gets the unique identifier for the `Coauthor` object. + * Specifies whether users can change the document theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + isThemeLocked?: boolean; /** - * Gets whether this author represents the current user. + * Specifies whether the document was created or opened by the user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + isUserControl?: boolean; /** - * Gets the display name of the coauthor. + * Gets whether the VBA project is digitally signed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ - interface CoauthorCollectionData { - items?: Word.Interfaces.CoauthorData[]; - } - /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ - interface CoauthoringData { + isVbaSigned?: boolean; /** - * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * Gets whether the document is protected with a write password. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - authors?: Word.Interfaces.CoauthorData[]; + isWriteReserved?: boolean; /** - * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * Specifies the character spacing adjustment. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflicts?: Word.Interfaces.ConflictData[]; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locks?: Word.Interfaces.CoauthoringLockData[]; + kind?: Word.DocumentKind | "NotSpecified" | "Letter" | "Email"; /** - * Gets a `Coauthor` object that represents the current user. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - me?: Word.Interfaces.CoauthorData; + languageDetected?: boolean; /** - * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - updates?: Word.Interfaces.CoauthoringUpdateData[]; + noLineBreakAfter?: string; /** - * Gets whether this document can be coauthored. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canCoauthor?: boolean; + noLineBreakBefore?: string; /** - * Gets whether the document can be automatically merged. + * Gets the encoding used to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canMerge?: boolean; + openEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets whether the document has pending updates that have not been accepted. + * Gets the title of the original document after legal-blackline comparison. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pendingUpdates?: boolean; - } - /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ - interface CoauthoringUpdateData { + originalDocumentTitle?: string; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Sets a password that must be supplied to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; - } - /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ - interface CoauthoringUpdateCollectionData { - items?: Word.Interfaces.CoauthoringUpdateData[]; - } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - interface CommentData { + password?: string; /** - * Specifies the comment's content range. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeData; + passwordEncryptionAlgorithm?: string; /** - * Gets the collection of reply objects associated with the comment. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replies?: Word.Interfaces.CommentReplyData[]; + passwordEncryptionKeyLength?: number; /** - * Gets the email of the comment's author. + * Gets the name of the password encryption provider. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + passwordEncryptionProvider?: string; /** - * Gets the name of the comment's author. + * Gets the disk or the web path to the document (excludes the document name). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + path?: string; /** - * Specifies the comment's content as plain text. + * Specifies whether revision marks are printed with the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + printRevisions?: boolean; /** - * Gets the creation date of the comment. + * Gets the protection type for the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + protectionType?: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"; /** - * Gets the ID of the comment. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + readingLayoutSizeX?: number; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - interface CommentContentRangeData { + readingLayoutSizeY?: number; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + readingModeIsLayoutFrozen?: boolean; /** - * 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. + * Specifies whether Word removes user information upon saving. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + removePersonalInformationOnSave?: boolean; /** - * Checks whether the range length is zero. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + revisedDocumentTitle?: string; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the encoding used when saving the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + saveEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Gets the file format of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + saveFormat?: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument"; /** - * Gets the text of the comment range. + * 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. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - text?: string; + saved?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies the encoding for saving as encoded text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface describing the data returned by calling `commentReply.toJSON()`. */ - interface CommentReplyData { - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; - /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + textEncoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Gets the email of the comment reply's author. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + textLineEnding?: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps"; /** - * Gets the name of the comment reply's author. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + trackFormatting?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + trackMoves?: boolean; /** - * Gets the creation date of the comment reply. + * Specifies whether changes are tracked in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + trackRevisions?: boolean; /** - * Gets the ID of the comment reply. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; - } - /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ - interface CommentReplyCollectionData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ - interface ConditionalStyleData { + trackedChangesAreDateAndTimeRemoved?: boolean; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * Gets the document type (template or document). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomPadding?: number; + type?: Word.DocumentType | "Document" | "Template" | "Frameset"; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * Sets a password for saving changes to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: number; + writePassword?: string; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightPadding?: number; + xmlAreAdvancedErrorsShown?: boolean; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: number; - } - /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ - interface XmlMappingData { + xmlIsXsltUsedWhenSaving?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + xmlSaveThroughXSLT?: string; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + interface DocumentCreatedData { /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + interface DocumentPropertiesData { /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + applicationName?: string; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: string; + author?: string; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xpath?: string; - } - /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ - interface CustomXmlPrefixMappingCollectionData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ - interface CustomXmlPrefixMappingData { + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Gets the creation date of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + creationDate?: Date; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; + keywords?: string; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - interface CustomXmlSchemaData { + lastAuthor?: string; /** - * Gets the location of the schema on a computer. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - location?: string; + lastPrintDate?: Date; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; - } - /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ - interface CustomXmlSchemaCollectionData { - items?: Word.Interfaces.CustomXmlSchemaData[]; - } - /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ - interface CustomXmlValidationErrorCollectionData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; - } - /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ - interface CustomXmlValidationErrorData { + lastSaveTime?: Date; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - node?: Word.Interfaces.CustomXmlNodeData; + manager?: string; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - errorCode?: number; + revisionNumber?: string; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: string; + security?: number; /** - * Gets the text in the `CustomXmlValidationError` object. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: string; + subject?: string; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the template of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; - } - /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ - interface CustomXmlNodeCollectionData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ - interface CustomXmlNodeData { + template?: string; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + interface FieldData { /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + code?: string; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + data?: string; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the field's kind. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + locked?: boolean; /** - * Gets the object representing the part associated with this node. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + showCodes?: boolean; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + } + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + interface FontData { /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: string; + fill?: Word.Interfaces.FillFormatData; /** - * Gets the unique address identifier for the namespace of the node. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + glow?: Word.Interfaces.GlowFormatData; /** - * Gets the type of the current node. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + line?: Word.Interfaces.LineFormatData; /** - * Specifies the value of the current node. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; + reflection?: Word.Interfaces.ReflectionFormatData; /** - * Specifies the text for the current node. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + textColor?: Word.Interfaces.ColorFormatData; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: string; + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Gets the XML representation of the current node and its children. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - interface ContentControlData { + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: + + - `true`: All the text has the **All Caps** attribute. + + - `false`: None of the text has the **All Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + allCaps?: boolean; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.1] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + bold?: boolean; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is bold. + + - `false`: None of the text is bold. + + - `null`: Returned if some, but not all, of the text is bold. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + boldBidirectional?: boolean; /** - * Gets the collection of content control objects in the content control. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApi 1.1] */ - contentControls?: Word.Interfaces.ContentControlData[]; + color?: string; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the collection of field objects in the content control. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + contextualAlternates?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + diacriticColor?: string; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlData; + disableCharacterSpaceGrid?: boolean; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @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[]; + doubleStrikeThrough?: boolean; /** - * Gets the collection of paragraph objects in the content control. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @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. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + emboss?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + engrave?: boolean; /** - * Gets the collection of table objects in the content control. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - tables?: Word.Interfaces.TableData[]; + hidden?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xmlMapping?: Word.Interfaces.XmlMappingData; + highlightColor?: string; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + italic?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: + + - `true`: All the text is italicized. + + - `false`: None of the text is italicized. + + - `null`: Returned if some, but not all, of the text is italicized. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + italicBidirectional?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + kerning?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the ligature setting for the `Font` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Gets an integer that represents the content control identifier. + * Specifies a value that represents the name of the font. * * @remarks * [Api set: WordApi 1.1] */ - id?: number; + name?: string; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + nameAscii?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the font name in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + nameBidirectional?: string; /** - * Specifies the style name for the content control. 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. + * Specifies the East Asian font name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + nameFarEast?: string; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + nameOther?: string; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * Specifies a tag to identify a content control. + * Specifies the number spacing setting for the font. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Gets the text of the content control. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + outline?: boolean; /** - * Specifies the title for a content control. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; + position?: number; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Specifies the scaling percentage applied to the font. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; - } - /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ - interface ContentControlCollectionData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ - interface ContentControlListItemData { + scaling?: number; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + shadow?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - index?: number; + size?: number; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the font size in points for right-to-left text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ - interface ContentControlListItemCollectionData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface describing the data returned by calling `customProperty.toJSON()`. */ - interface CustomPropertyData { + sizeBidirectional?: number; /** - * Gets the key of the custom property. + * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: + + - `true`: All the text has the **Small Caps** attribute. + + - `false`: None of the text has the **Small Caps** attribute. + + - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + smallCaps?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the spacing between characters. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + spacing?: number; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: any; - } - /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ - interface CustomPropertyCollectionData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ - interface CustomXmlPartData { + strikeThrough?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + subscript?: boolean; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + superscript?: boolean; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; - /** - * Gets the ID of the custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - id?: string; + underlineColor?: string; + } + /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ + interface HeadingStyleData { /** - * Gets the namespace URI of the custom XML part. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + level?: number; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the name of style for a heading. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ - interface CustomXmlPartCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + name?: string; } - /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ - interface CustomXmlPartScopedCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ + interface HeadingStyleCollectionData { + items?: Word.Interfaces.HeadingStyleData[]; } - /** An interface describing the data returned by calling `document.toJSON()`. */ - interface DocumentData { + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { /** - * Gets the active window for the document. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + range?: Word.Interfaces.RangeData; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + address?: string; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + emailSubject?: string; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coauthoring?: Word.Interfaces.CoauthoringData; + isExtraInfoRequired?: boolean; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + name?: string; /** - * Gets the custom XML parts in the document. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + screenTip?: string; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + subAddress?: string; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frames?: Word.Interfaces.FrameData[]; + target?: string; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + textToDisplay?: string; /** - * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplates?: Word.Interfaces.ListTemplateData[]; + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; + } + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + interface InlinePictureData { /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageSetup?: Word.Interfaces.PageSetupData; + altTextDescription?: string; /** - * Gets the properties of the document. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - properties?: Word.Interfaces.DocumentPropertiesData; + altTextTitle?: string; /** - * Gets the collection of section objects in the document. + * Specifies a number that describes the height of the inline image. * * @remarks * [Api set: WordApi 1.1] */ - sections?: Word.Interfaces.SectionData[]; + height?: number; /** - * Returns a `Selection` object that represents the current selection in the document. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - selection?: Word.Interfaces.SelectionData; + hyperlink?: string; /** - * Gets the add-in's settings in the document. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - settings?: Word.Interfaces.SettingData[]; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Gets the collection of `Word.Window` objects for the document. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - windows?: Word.Interfaces.WindowData[]; + lockAspectRatio?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoHyphenation?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ + interface LinkFormatData { /** - * Specifies if the edits in the document are automatically saved. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + isAutoUpdated?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + isLocked?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + isPictureSavedWithDocument?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + sourceFullName?: string; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + sourceName?: string; /** - * 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. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ - interface DocumentCreatedData { - /** - * 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.BodyData; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; - /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + sourcePath?: string; /** - * 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. + * Gets the link type. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - interface DocumentPropertiesData { + /** An interface describing the data returned by calling `list.toJSON()`. */ + interface ListData { /** - * Gets the collection of custom properties of the document. + * Gets paragraphs in the list. * * @remarks * [Api set: WordApi 1.3] */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Gets the application name of the document. + * Gets the list's id. * * @remarks * [Api set: WordApi 1.3] */ - applicationName?: string; + id?: number; /** - * Specifies the author of the document. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + levelExistences?: boolean[]; /** - * Specifies the category of the document. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks * [Api set: WordApi 1.3] */ - category?: string; + levelTypes?: Word.ListLevelType[]; + } + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + interface ListCollectionData { + items?: Word.Interfaces.ListData[]; + } + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + interface ListItemData { /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the level of the item in the list. * * @remarks * [Api set: WordApi 1.3] */ - comments?: string; + level?: number; /** - * Specifies the company of the document. + * Gets the list item bullet, number, or picture as a string. * * @remarks * [Api set: WordApi 1.3] */ - company?: string; + listString?: string; /** - * Gets the creation date of the document. + * Gets the list item order number in relation to its siblings. * * @remarks * [Api set: WordApi 1.3] */ - creationDate?: Date; + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + interface ListLevelData { /** - * Specifies the format of the document. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - format?: string; + font?: Word.Interfaces.FontData; /** - * Specifies the keywords of the document. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - keywords?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the last author of the document. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastAuthor?: string; + linkedStyle?: string; /** - * Gets the last print date of the document. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastPrintDate?: Date; + numberFormat?: string; /** - * Gets the last save time of the document. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - lastSaveTime?: Date; + numberPosition?: number; /** - * Specifies the manager of the document. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - manager?: string; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Gets the revision number of the document. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - revisionNumber?: string; + resetOnHigher?: number; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - security?: number; + startAt?: number; /** - * Specifies the subject of the document. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - subject?: string; + tabPosition?: number; /** - * Gets the template of the document. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - template?: string; + textPosition?: number; /** - * Specifies the title of the document. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - title?: string; - } - /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ - interface DropDownListContentControlData { + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; } - /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ - interface ComboBoxContentControlData { + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; } - /** An interface describing the data returned by calling `field.toJSON()`. */ - interface FieldData { - /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + interface ListTemplateData { /** - * Specifies the field's code instruction. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApiDesktop 1.1] */ - code?: string; + listLevels?: Word.Interfaces.ListLevelData[]; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the name of the list template. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - data?: string; + name?: string; /** - * Gets the field's kind. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + outlineNumbered?: boolean; + } + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + interface NoteItemData { /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * 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] */ - locked?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - showCodes?: boolean; + reference?: Word.Interfaces.RangeData; /** - * Gets the field's type. + * Represents the note item type: footnote or endnote. * * @remarks * [Api set: WordApi 1.5] */ - type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + type?: Word.NoteItemType | "Footnote" | "Endnote"; } - /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ - interface FieldCollectionData { - items?: Word.Interfaces.FieldData[]; + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; } - /** An interface describing the data returned by calling `font.toJSON()`. */ - interface FontData { + /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ + interface OleFormatData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + classType?: string; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatData; + iconIndex?: number; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatData; + iconLabel?: string; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + iconName?: string; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + iconPath?: string; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatData; + isDisplayedAsIcon?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatData; + isFormattingPreservedOnUpdate?: boolean; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + label?: string; /** - * Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters. The possible values are as follows: - - - `true`: All the text has the **All Caps** attribute. - - - `false`: None of the text has the **All Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **All Caps** attribute. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + progId?: string; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + interface PageData { /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + breaks?: Word.Interfaces.BreakData[]; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is bold. - - - `false`: None of the text is bold. - - - `null`: Returned if some, but not all, of the text is bold. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - boldBidirectional?: boolean; + height?: number; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + index?: number; + /** + * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + interface PaneData { + /** + * Gets the collection of pages in the pane. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pages?: Word.Interfaces.PageData[]; + /** + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pagesEnclosingViewport?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + interface WindowData { + /** + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + next?: Word.Interfaces.WindowData; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + previous?: Word.Interfaces.WindowData; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies whether rulers are displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areRulersDisplayed?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + areScreenTipsDisplayed?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + areThumbnailsDisplayed?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + caption?: string; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + height?: number; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + horizontalPercentScrolled?: number; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Gets the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + index?: number; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden?: boolean; + isActive?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + isDocumentMapVisible?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. The possible values are as follows: - - - `true`: All the text is italicized. - - - `false`: None of the text is italicized. - - - `null`: Returned if some, but not all, of the text is italicized. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + isRightRulerDisplayed?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + isSplit?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the East Asian font name. + * Specifies whether the window is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + isVisible?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies the horizontal position of the window, measured in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + left?: number; /** - * Specifies the number form setting for an OpenType font. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Specifies the number spacing setting for the font. + * Specifies the vertical split percentage for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + splitVertical?: number; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the width of the style area in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + styleAreaWidth?: number; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the vertical position of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + top?: number; /** - * Specifies the scaling percentage applied to the font. + * Gets the window type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + type?: Word.WindowType | "Document" | "Template"; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Gets the height (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + usableHeight?: number; /** - * Specifies a value that represents the font size in points. + * Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - size?: number; + usableWidth?: number; /** - * Specifies the font size in points for right-to-left text. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + verticalPercentScrolled?: number; /** - * Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters. The possible values are as follows: - - - `true`: All the text has the **Small Caps** attribute. - - - `false`: None of the text has the **Small Caps** attribute. - - - `null`: Returned if some, but not all, of the text has the **Small Caps** attribute. + * Specifies the width of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + width?: number; /** - * Specifies the spacing between characters. + * Gets an integer that represents the position of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + windowNumber?: number; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + } + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface describing the data returned by calling `paragraph.toJSON()`. */ + interface ParagraphData { /** - * Specifies the stylistic set for the font. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Gets the collection of fields in the paragraph. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - subscript?: boolean; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * 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] */ - superscript?: boolean; + font?: Word.Interfaces.FontData; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - underlineColor?: string; - } - /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ - interface HeadingStyleData { + listItem?: Word.Interfaces.ListItemData; /** - * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - level?: number; + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Specifies the name of style for a heading. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ - interface HeadingStyleCollectionData { - items?: Word.Interfaces.HeadingStyleData[]; - } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - interface HyperlinkData { + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - range?: Word.Interfaces.RangeData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - address?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - emailSubject?: string; + firstLineIndent?: number; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isExtraInfoRequired?: boolean; + isLastParagraph?: boolean; /** - * Returns the name of the `Hyperlink` object. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: string; + isListItem?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - screenTip?: string; + leftIndent?: number; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - subAddress?: string; + lineSpacing?: number; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - target?: string; + lineUnitAfter?: number; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - textToDisplay?: string; + lineUnitBefore?: number; /** - * Returns the hyperlink type. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - } - /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ - interface HyperlinkCollectionData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ - interface InlinePictureData { + outlineLevel?: number; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies the right indent value, in points, for the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - altTextDescription?: string; + rightIndent?: number; /** - * Specifies a string that contains the title for the inline image. + * Specifies the spacing, in points, after the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - altTextTitle?: string; + spaceAfter?: number; /** - * Specifies a number that describes the height of the inline image. + * Specifies the spacing, in points, before the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - height?: number; + spaceBefore?: number; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the style name for the paragraph. 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. * * @remarks * [Api set: WordApi 1.1] */ - hyperlink?: string; + style?: string; /** - * Gets the format of the inline image. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - lockAspectRatio?: boolean; + tableNestingLevel?: number; /** - * Specifies a number that describes the width of the inline image. + * Gets the text of the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ - interface LinkFormatData { - /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - isAutoUpdated?: boolean; + text?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isLocked?: boolean; + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + interface ParagraphFormatData { /** - * Specifies if the linked picture is saved with the document. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isPictureSavedWithDocument?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourceFullName?: string; + firstLineIndent?: number; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourceName?: string; + keepTogether?: boolean; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourcePath?: string; + keepWithNext?: boolean; /** - * Gets the link type. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - } - /** An interface describing the data returned by calling `list.toJSON()`. */ - interface ListData { - /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + leftIndent?: number; /** - * Gets the list's id. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - id?: number; + lineSpacing?: number; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelExistences?: boolean[]; + lineUnitAfter?: number; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelTypes?: Word.ListLevelType[]; - } - /** An interface describing the data returned by calling `listCollection.toJSON()`. */ - interface ListCollectionData { - items?: Word.Interfaces.ListData[]; - } - /** An interface describing the data returned by calling `listItem.toJSON()`. */ - interface ListItemData { + lineUnitBefore?: number; /** - * Specifies the level of the item in the list. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - level?: number; + mirrorIndents?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listString?: string; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Gets the list item order number in relation to its siblings. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - interface ListLevelData { + rightIndent?: number; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontData; + spaceAfter?: number; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + spaceBefore?: number; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - linkedStyle?: string; + widowControl?: boolean; + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + interface RangeData { /** - * Specifies the number format for the specified list level. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies the number style for the list level object. + * Gets the collection of field objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - resetOnHigher?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the starting number for the specified list level object. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the tab position for the specified list level object. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.2] */ - textPosition?: number; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the character inserted after the number for the specified list level. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ - interface ListLevelCollectionData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ - interface ListTemplateData { + listFormat?: Word.Interfaces.ListFormatData; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Gets the collection of pages in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - listLevels?: Word.Interfaces.ListLevelData[]; + pages?: Word.Interfaces.PageData[]; /** - * Specifies the name of the list template. + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + sections?: Word.Interfaces.SectionData[]; /** - * Specifies whether the list template is outline numbered. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - interface NoteItemData { + shading?: Word.Interfaces.ShadingUniversalData; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Represents a footnote or endnote reference in the main document. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Represents the note item type: footnote or endnote. + * Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; - } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ - interface OleFormatData { + bold?: boolean; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + boldBidirectional?: boolean; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex?: number; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel?: string; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: string; + combineCharacters?: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconPath?: string; + disableCharacterSpaceGrid?: boolean; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDisplayedAsIcon?: boolean; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate?: boolean; + end?: number; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - label?: string; + fitTextWidth?: number; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - progID?: string; - } - /** An interface describing the data returned by calling `page.toJSON()`. */ - interface PageData { + grammarChecked?: boolean; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - breaks?: Word.Interfaces.BreakData[]; + hasNoProofing?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * 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. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - width?: number; - } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - interface PageCollectionData { - items?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - interface PaneData { + hyperlink?: string; /** - * Gets the collection of pages in the pane. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pages?: Word.Interfaces.PageData[]; + id?: string; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pagesEnclosingViewport?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ - interface PaneCollectionData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface describing the data returned by calling `window.toJSON()`. */ - interface WindowData { + isEmpty?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.WindowData; + isEndOfRowMark?: boolean; /** - * Gets the previous document window in the collection open document windows. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.WindowData; + isTextVisibleOnScreen?: boolean; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies if the font or range is formatted as italic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + italic?: boolean; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areScreenTipsDisplayed?: boolean; + italicBidirectional?: boolean; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areThumbnailsDisplayed?: boolean; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caption?: string; + languageDetected?: boolean; /** - * Specifies the height of the window (in points). + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPercentScrolled?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the position of an item in a collection. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + showAll?: boolean; /** - * Specifies whether the window is active. + * Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + spellingChecked?: boolean; /** - * Specifies whether the document map is visible. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDocumentMapVisible?: boolean; + start?: number; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEnvelopeVisible?: boolean; + storyLength?: number; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHorizontalScrollBarDisplayed?: boolean; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the style name for the range. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isLeftScrollBarDisplayed?: boolean; + style?: string; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isRightRulerDisplayed?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies whether the window is split into multiple panes. + * Gets the text of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isSplit?: boolean; + text?: string; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalRulerDisplayed?: boolean; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed?: boolean; + underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + interface SearchOptionsData { /** - * Specifies whether the window is visible. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + ignorePunct?: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - left?: number; + ignoreSpace?: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + matchCase?: boolean; /** - * Specifies the vertical split percentage for the window. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - splitVertical?: number; + matchPrefix?: boolean; /** - * Specifies the width of the style area in points. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - styleAreaWidth?: number; + matchSuffix?: boolean; /** - * Specifies the vertical position of the document window, in points. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - top?: number; + matchWholeWord?: boolean; /** - * Gets the window type. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.WindowType | "Document" | "Template"; + matchWildcards?: boolean; + } + /** An interface describing the data returned by calling `section.toJSON()`. */ + interface SectionData { /** - * Gets the height (in points) of the active working area in the document window. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableHeight?: number; + body?: Word.Interfaces.BodyData; /** - * Gets the width (in points) of the active working area in the document window. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: number; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies the width of the document window, in points. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + protectedForForms?: boolean; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + interface SettingData { /** - * Gets an integer that represents the position of the window. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - windowNumber?: number; + key?: string; /** - * Specifies the state of the document window or task window. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + value?: any; } - /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ - interface WindowCollectionData { - items?: Word.Interfaces.WindowData[]; + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; } - /** An interface describing the data returned by calling `paragraph.toJSON()`. */ - interface ParagraphData { + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + interface StyleData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * 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] + */ + font?: Word.Interfaces.FontData; + /** + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + frame?: Word.Interfaces.FrameData; /** - * Gets the collection of fields in the paragraph. + * Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + linkStyle?: Word.Interfaces.StyleData; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - font?: Word.Interfaces.FontData; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listItem?: Word.Interfaces.ListItemData; + shading?: Word.Interfaces.ShadingData; /** - * 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}. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + automaticallyUpdate?: boolean; /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - shapes?: Word.Interfaces.ShapeData[]; - /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * [Api set: WordApi 1.5] * - * @remarks - * [Api set: WordApi 1.1] + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + baseStyle?: string; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - firstLineIndent?: number; + builtIn?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Gets the description of the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + description?: string; /** - * Checks whether the paragraph is a list item. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + hasProofing?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - leftIndent?: number; + inUse?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies an East Asian language for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - lineUnitBefore?: number; + linked?: boolean; /** - * Specifies the outline level for the paragraph. + * Returns the list level for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + listLevelNumber?: number; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + locked?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - spaceAfter?: number; + nameLocal?: string; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - spaceBefore?: number; + nextParagraphStyle?: string; /** - * Specifies the style name for the paragraph. 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. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + priority?: number; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - tableNestingLevel?: number; + quickStyle?: boolean; /** - * Gets the text of the paragraph. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: string; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - interface ParagraphFormatData { + unhideWhenUsed?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + interface ShadingData { /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - firstLineIndent?: number; + backgroundPatternColor?: string; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - keepTogether?: boolean; + foregroundPatternColor?: string; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - keepWithNext?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + interface ShadingUniversalData { /** - * Specifies the left indent. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + backgroundPatternColor?: string; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + foregroundPatternColor?: string; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether left and right indents are the same width. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + interface TableData { /** - * Specifies the outline level for the specified paragraphs. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceAfter?: number; + rows?: Word.Interfaces.TableRowData[]; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceBefore?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - interface RangeData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + description?: string; /** - * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - conflicts?: Word.Interfaces.ConflictData[]; + headerRowCount?: number; /** - * Gets the collection of field objects in the range. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + isUniform?: boolean; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frames?: Word.Interfaces.FrameData[]; + nestingLevel?: number; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + rowCount?: number; /** - * Gets the collection of inline picture objects in the range. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + shadingColor?: string; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the style name for the table. 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listFormat?: Word.Interfaces.ListFormatData; + style?: string; /** - * Gets the collection of pages in the range. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + styleBandedColumns?: boolean; /** - * Gets the collection of sections in the range. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + styleBandedRows?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalData; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + styleFirstColumn?: boolean; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tableColumns?: Word.Interfaces.TableColumnData[]; + styleLastColumn?: boolean; /** - * Specifies whether the range is formatted as bold. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bold?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + title?: string; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + values?: string[][]; /** - * Specifies the character width of the range. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies if the range contains combined characters. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - combineCharacters?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - disableCharacterSpaceGrid?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the emphasis mark for a character or designated character string. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + allowBreakAcrossPage?: boolean; /** - * Specifies the ending character position of the range. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - end?: number; + bottomCellMargin?: number; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - fitTextWidth?: number; + cellSpacing?: number; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + columnStripe?: number; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies the highlight color for the range. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + leftCellMargin?: number; /** - * Specifies the formatting for horizontal text set within vertical text. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + leftIndent?: number; /** - * 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. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + rightCellMargin?: number; /** - * Specifies the ID for the range. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + rowStripe?: number; /** - * Checks whether the range length is zero. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isEndOfRowMark?: boolean; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + interface TabStopData { /** - * Gets whether the text in the range is visible on the screen. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTextVisibleOnScreen?: boolean; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies if the font or range is formatted as italic. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + customTab?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + position?: number; + } + /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ + interface TabStopCollectionData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + interface TableColumnData { /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies an East Asian language for the range. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + columnIndex?: number; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isFirst?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + isLast?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + nestingLevel?: number; /** - * Specifies the starting character position of the range. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + preferredWidth?: number; /** - * Gets the number of characters in the story that contains the range. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Gets the story type for the range. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + width?: number; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + interface TableColumnCollectionData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ + interface TableOfAuthoritiesData { /** - * Specifies the style name for the range. 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. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + bookmark?: string; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + category?: number; /** - * Gets the text of the range. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + entrySeparator?: string; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + isCategoryHeaderIncluded?: boolean; /** - * Specifies the type of underline applied to the range. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - interface SearchOptionsData { + isEntryFormattingKept?: boolean; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + isPassimUsed?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + pageNumberSeparator?: string; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + pageRangeSeparator?: string; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + sequenceName?: string; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + sequenceSeparator?: string; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ + interface TableOfAuthoritiesCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ + interface TableOfAuthoritiesCategoryData { /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; + name?: string; } - /** An interface describing the data returned by calling `section.toJSON()`. */ - interface SectionData { + /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ + interface TableOfAuthoritiesCategoryCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ + interface TableOfContentsData { /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + areBuiltInHeadingStylesUsed?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + areFieldsUsed?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupData; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - interface SettingData { + arePageNumbersHiddenOnWeb?: boolean; /** - * Gets the key of the setting. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + arePageNumbersIncluded?: boolean; /** - * Specifies the value of the setting. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ - interface SettingCollectionData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ - interface StyleCollectionData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface describing the data returned by calling `style.toJSON()`. */ - interface StyleData { + arePageNumbersRightAligned?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderData[]; + lowerHeadingLevel?: number; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameData; + tableId?: string; /** - * Specifies a link between a paragraph and a character style. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleData; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ + interface TableOfContentsCollectionData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ + interface TableOfFiguresData { /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + areBuiltInHeadingStylesUsed?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + areFieldsUsed?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingData; + areHyperlinksUsedOnWeb?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleData; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + arePageNumbersRightAligned?: boolean; /** - * Gets whether the specified style is a built-in style. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + captionLabel?: string; /** - * Gets the description of the specified style. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + isLabelIncluded?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + lowerHeadingLevel?: number; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + tableId?: string; /** - * Specifies an East Asian language for the style. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ + interface TableOfFiguresCollectionData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + interface TableRowData { /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cells?: Word.Interfaces.TableCellData[]; + /** + * Gets the collection of field objects in the table row. + * + * @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] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - linked?: boolean; + cellCount?: number; /** - * Returns the list level for the style. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listLevelNumber?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the style cannot be changed or edited. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - locked?: boolean; + isHeader?: boolean; /** - * Gets the name of a style in the language of the user. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nameLocal?: string; + preferredHeight?: number; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - nextParagraphStyle?: string; + rowIndex?: number; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + shadingColor?: string; /** - * Specifies the priority. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - priority?: number; + values?: string[][]; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quickStyle?: boolean; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + interface TableCellData { /** - * Gets the style type. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + body?: Word.Interfaces.BodyData; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - unhideWhenUsed?: boolean; + cellIndex?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - interface ShadingData { + columnWidth?: number; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: string; + rowIndex?: number; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - interface ShadingUniversalData { + shadingColor?: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: string; + value?: string; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: string; + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + interface TableBorderData { /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + color?: string; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `table.toJSON()`. */ - interface TableData { + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Gets the collection of field objects in the table. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + width?: number; + } + /** An interface describing the data returned by calling `template.toJSON()`. */ + interface TemplateData { /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets all of the table rows. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rows?: Word.Interfaces.TableRowData[]; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Gets the child tables nested one level deeper. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + fullName?: string; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + hasNoProofing?: boolean; /** - * Specifies the description of the table. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies the number of header rows. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + kerningByAlgorithm?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Indicates whether all of the table rows are uniform. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isUniform?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: number; + name?: string; /** - * Gets the number of rows in the table. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: number; + noLineBreakAfter?: string; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + noLineBreakBefore?: string; /** - * Specifies the style name for the table. 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. + * Returns the path to the document template. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + path?: string; /** - * Specifies whether the table has banded columns. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + saved?: boolean; /** - * Specifies whether the table has banded rows. + * Returns the template type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; + } + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + interface TrackedChangeData { /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + author?: string; /** - * Specifies whether the table has a first column with a special style. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleFirstColumn?: boolean; + date?: Date; /** - * Specifies whether the table has a last column with a special style. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleLastColumn?: boolean; + text?: string; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - styleTotalRow?: boolean; + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `view.toJSON()`. */ + interface ViewData { /** - * Specifies the title of the table. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + areBackgroundsDisplayed?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + areBookmarksIndicated?: boolean; /** - * Specifies the width of the table in points. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - interface TableStyleData { + areCommentsDisplayed?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + areCropMarksDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + areDrawingsDisplayed?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + areEditableRangesShaded?: boolean; /** - * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnStripe?: number; + areFieldCodesDisplayed?: boolean; /** - * Specifies whether Microsoft Word allows to break the specified table across pages. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isBreakAcrossPagesAllowed?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the left indent value (in points) for the rows in the table style. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftIndent?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + areLinesWrappedToWindow?: boolean; /** - * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rowStripe?: number; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies the direction in which Microsoft Word orders cells in the table style. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface describing the data returned by calling `tabStop.toJSON()`. */ - interface TabStopData { + areOptionalHyphensDisplayed?: boolean; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Gets whether other authors' presence should be visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + areOtherAuthorsVisible?: boolean; /** - * Gets whether this tab stop is a custom tab stop. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + arePageBoundariesDisplayed?: boolean; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * Gets whether paragraph marks are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + areParagraphsMarksDisplayed?: boolean; /** - * Gets the position of the tab stop relative to the left margin. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; - } - /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ - interface TabStopCollectionData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - interface TableCollectionData { - items?: Word.Interfaces.TableData[]; - } - /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ - interface TableColumnData { + arePicturePlaceholdersDisplayed?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets whether space characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + areSpacesIndicated?: boolean; /** - * Returns the position of this column in a collection. + * Specifies whether table gridlines are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: number; + areTableGridlinesDisplayed?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Gets whether tab characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areTabsDisplayed?: boolean; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areTextBoundariesDisplayed?: boolean; /** - * Returns the nesting level of the column. + * Specifies the column width in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: number; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets on-screen shading for fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + isDraft?: boolean; /** - * Specifies the width of the column, in points. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ - interface TableColumnCollectionData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ - interface TableOfAuthoritiesData { + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the name of the bookmark from which to collect table of authorities entries. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmark?: string; + isFormatDisplayed?: boolean; /** - * Specifies the category of entries to be included in the table of authorities. - Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + * Specifies whether the window is in full-screen view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: number; + isFullScreen?: boolean; /** - * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + * Gets whether text formatted as hidden text is displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entrySeparator?: string; + isHiddenTextDisplayed?: boolean; /** - * Specifies whether the category name for a group of entries appears in the table of authorities. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCategoryHeaderIncluded?: boolean; + isHighlightingDisplayed?: boolean; /** - * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. + * Specifies whether the document is in conflict mode view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEntryFormattingKept?: boolean; + isInConflictMode?: boolean; /** - * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPassimUsed?: boolean; + isInPanning?: boolean; /** - * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberSeparator?: string; + isInReadingLayout?: boolean; /** - * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageRangeSeparator?: string; + isMailMergeDataView?: boolean; /** - * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceName?: string; + isMainTextLayerVisible?: boolean; /** - * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sequenceSeparator?: string; + isPointerShownAsMagnifier?: boolean; /** - * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ - interface TableOfAuthoritiesCollectionData { - items?: Word.Interfaces.TableOfAuthoritiesData[]; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ - interface TableOfAuthoritiesCategoryData { + isReadingLayoutActualView?: boolean; /** - * Specifies the name of this table of authorities category. - Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ - interface TableOfAuthoritiesCategoryCollectionData { - items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; - } - /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ - interface TableOfContentsData { + isXmlMarkupVisible?: boolean; /** - * Specifies whether built-in heading styles are used for the table of contents. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBuiltInHeadingStylesUsed?: boolean; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldsUsed?: boolean; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areHyperlinksUsedOnWeb?: boolean; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersHiddenOnWeb?: boolean; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies whether page numbers are included in the table of contents. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersIncluded?: boolean; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies whether page numbers are aligned with the right margin in the table of contents. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageNumbersRightAligned?: boolean; + revisionsBalloonWidth?: number; /** - * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lowerHeadingLevel?: number; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the character between entries and their page numbers in the table of contents. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableId?: string; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upperHeadingLevel?: number; - } - /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ - interface TableOfContentsCollectionData { - items?: Word.Interfaces.TableOfContentsData[]; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; } - /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ - interface TableOfFiguresData { + /** An interface describing the data returned by calling `shape.toJSON()`. */ + interface ShapeData { /** - * Specifies whether built-in heading styles are used for the table of figures. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areBuiltInHeadingStylesUsed?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 + * [Api set: WordApiDesktop 1.2] */ - areFieldsUsed?: boolean; + canvas?: Word.Interfaces.CanvasData; /** - * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areHyperlinksUsedOnWeb?: boolean; + fill?: Word.Interfaces.ShapeFillData; /** - * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersHiddenOnWeb?: boolean; + parentCanvas?: Word.Interfaces.ShapeData; /** - * Specifies whether page numbers are included in the table of figures. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersIncluded?: boolean; + parentGroup?: Word.Interfaces.ShapeData; /** - * Specifies whether page numbers are aligned with the right margin in the table of figures. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 + * [Api set: WordApiDesktop 1.2] */ - arePageNumbersRightAligned?: boolean; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Specifies the label that identifies the items to be included in the table of figures. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - captionLabel?: string; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies whether the caption label and caption number are included in the table of figures. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isLabelIncluded?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lowerHeadingLevel?: number; + allowOverlap?: boolean; /** - * Specifies the character between entries and their page numbers in the table of figures. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + altTextDescription?: string; /** - * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tableId?: string; + geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; /** - * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - upperHeadingLevel?: number; - } - /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ - interface TableOfFiguresCollectionData { - items?: Word.Interfaces.TableOfFiguresData[]; - } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - interface TableRowData { + height?: number; /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + heightRelative?: number; /** - * Gets the collection of field objects in the table row. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; /** - * 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; + * Check whether this shape is a child of a group shape or a canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + isChild?: boolean; /** - * Gets the number of cells in the row. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - cellCount?: number; + left?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + leftRelative?: number; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isHeader?: boolean; + lockAspectRatio?: boolean; /** - * Specifies the preferred height of the row in points. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - preferredHeight?: number; + name?: string; /** - * Gets the index of the row in its parent table. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowIndex?: number; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: string[][]; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ - interface TableRowCollectionData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface describing the data returned by calling `tableCell.toJSON()`. */ - interface TableCellData { + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the body object of the cell. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyData; + rotation?: number; /** - * Gets the index of the cell in its row. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - cellIndex?: number; + top?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - columnWidth?: number; + topRelative?: number; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Gets the index of the cell's row in the table. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowIndex?: number; + visible?: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + width?: number; /** - * Specifies the text of the cell. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - value?: string; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + shape?: Word.Interfaces.ShapeData; /** - * Gets the width of the cell in points. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; - } - /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ - interface TableCellCollectionData { - items?: Word.Interfaces.TableCellData[]; + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the shape group identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; } - /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ - interface TableBorderData { + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + interface CanvasData { /** - * Specifies the table border color. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + shape?: Word.Interfaces.ShapeData; /** - * Specifies the type of the table border. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets an integer that represents the canvas identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + id?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + interface ShapeFillData { + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + backgroundColor?: string; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; - } - /** An interface describing the data returned by calling `template.toJSON()`. */ - interface TemplateData { + foregroundColor?: string; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + transparency?: number; /** - * Specifies the line break control level for the document. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + } + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + interface TextFrameData { /** - * Returns the name of the template, including the drive or Web path. + * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fullName?: string; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hasNoProofing?: boolean; + bottomMargin?: number; /** - * Specifies the character spacing adjustment for the template. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + hasText?: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - kerningByAlgorithm?: boolean; + leftMargin?: number; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + noTextRotation?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Returns only the name of the document template (excluding any path or other location information). + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - name?: string; + rightMargin?: number; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noLineBreakAfter?: string; + topMargin?: number; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noLineBreakBefore?: string; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Returns the path to the document template. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - path?: string; + wordWrap?: boolean; + } + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + interface ShapeTextWrapData { /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - saved?: boolean; + bottomDistance?: number; /** - * Returns the template type. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - type?: Word.TemplateType | "Normal" | "Global" | "Attached"; - } - /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ - interface TemplateCollectionData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - interface TrackedChangeData { + leftDistance?: number; /** - * Gets the author of the tracked change. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - author?: string; + rightDistance?: number; /** - * Gets the date of the tracked change. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - date?: Date; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Gets the text of the tracked change. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - text?: string; + topDistance?: number; /** - * Gets the type of the tracked change. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; - } - /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ - interface TrackedChangeCollectionData { - items?: Word.Interfaces.TrackedChangeData[]; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; } - /** An interface describing the data returned by calling `view.toJSON()`. */ - interface ViewData { + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + interface ReviewerData { /** - * Specifies whether all nonprinting characters are displayed. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + isVisible?: boolean; + } + /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ + interface ReviewerCollectionData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ + interface RevisionsFilterData { /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBookmarksIndicated?: boolean; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + interface RepeatingSectionItemData { /** - * Specifies whether Microsoft Word displays the comments in the document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `revision.toJSON()`. */ + interface RevisionData { /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + movedRange?: Word.Interfaces.RangeData; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCropMarksDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areDrawingsDisplayed?: boolean; + author?: string; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Gets the date and time when the tracked change was made. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + date?: Date; /** - * Specifies whether field codes are displayed. + * Gets the description of tracked formatting changes in the revision. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + formatDescription?: string; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Gets a number that represents the position of this item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + index?: number; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Gets the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ + interface RevisionCollectionData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + interface DatePickerContentControlData { /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areLinesWrappedToWindow?: boolean; + range?: Word.Interfaces.RangeData; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areObjectAnchorsDisplayed?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether Microsoft Word displays optional line breaks. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalBreaksDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether optional hyphens are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalHyphensDisplayed?: boolean; + color?: string; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageBoundariesDisplayed?: boolean; + dateDisplayFormat?: string; /** - * Gets whether paragraph marks are displayed. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areParagraphsMarksDisplayed?: boolean; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePicturePlaceholdersDisplayed?: boolean; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + id?: string; /** - * Gets whether space characters are displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areSpacesIndicated?: boolean; + isTemporary?: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets whether tab characters are displayed. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTabsDisplayed?: boolean; + lockContentControl?: boolean; /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTextBoundariesDisplayed?: boolean; + lockContents?: boolean; /** - * Specifies the column width in Reading mode. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + showingPlaceholderText?: boolean; /** - * Gets on-screen shading for fields. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + tag?: string; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + interface PictureContentControlData { /** - * Specifies whether only the first line of body text is shown in outline view. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies whether character formatting is visible in outline view. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies whether the window is in full-screen view. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether text formatted as hidden text is displayed. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHiddenTextDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHighlightingDisplayed?: boolean; + color?: string; /** - * Specifies whether the document is in conflict mode view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + id?: string; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + isTemporary?: boolean; /** - * Specifies whether the document is being viewed in reading layout view. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + lockContentControl?: boolean; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + lockContents?: boolean; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + tag?: string; /** - * Specifies whether XML tags are visible in the document. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + interface GroupContentControlData { /** - * Specifies the display mode for tracked changes. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the page color in Reading mode. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + range?: Word.Interfaces.RangeData; /** - * Specifies the page movement type. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; + color?: string; /** - * Specifies the width of the revision balloons. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + id?: string; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + isTemporary?: boolean; /** - * Specifies the document element displayed in print layout view. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the active window pane. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + lockContentControl?: boolean; /** - * Specifies the view type. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface describing the data returned by calling `shape.toJSON()`. */ - interface ShapeData { - /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - body?: Word.Interfaces.BodyData; + lockContents?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasData; + showingPlaceholderText?: boolean; /** - * Returns the fill formatting of the shape. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillData; + tag?: string; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeData; + title?: string; + } + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + interface BuildingBlockGalleryContentControlData { /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeData; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + range?: Word.Interfaces.RangeData; /** - * Gets the text frame object of the shape. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameData; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Returns the text wrap formatting of the shape. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + buildingBlockCategory?: string; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"; + color?: string; /** - * The height, in points, of the shape. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + id?: string; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + isTemporary?: boolean; /** - * Gets an integer that represents the shape identifier. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: boolean; + lockContentControl?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + lockContents?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets if the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + showingPlaceholderText?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + tag?: string; /** - * The name of the shape. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + title?: string; + } + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + interface RepeatingSectionContentControlData { /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + range?: Word.Interfaces.RangeData; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + xmlapping?: Word.Interfaces.XmlMappingData; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + allowInsertDeleteSection?: boolean; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + color?: string; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + id?: string; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + isTemporary?: boolean; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The width, in points, of the shape. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + lockContentControl?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - interface ShapeGroupData { + lockContents?: boolean; /** - * Gets the Shape object associated with the group. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + repeatingSectionItemTitle?: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + showingPlaceholderText?: boolean; /** - * Gets an integer that represents the shape group identifier. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - interface CanvasData { + tag?: string; /** - * Gets the Shape object associated with the canvas. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + title?: string; + } + /** An interface describing the data returned by calling `readabilityStatistic.toJSON()`. */ + interface ReadabilityStatisticData { /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Returns the name of the readability statistic. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + name?: string; /** - * Gets an integer that represents the canvas identifier. + * Returns the value of the grammar statistic. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + value?: number; } - /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ - interface ShapeCollectionData { - items?: Word.Interfaces.ShapeData[]; + /** An interface describing the data returned by calling `readabilityStatisticCollection.toJSON()`. */ + interface ReadabilityStatisticCollectionData { + items?: Word.Interfaces.ReadabilityStatisticData[]; } - /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ - interface ShapeFillData { + /** An interface describing the data returned by calling `webSettings.toJSON()`. */ + interface WebSettingsData { /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + allowPng?: boolean; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + encoding?: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; + folderSuffix?: string; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; - } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - interface TextFrameData { + organizeInFolder?: boolean; /** - * The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + pixelsPerInch?: number; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + relyOnCSS?: boolean; /** - * Specifies if the text frame contains text. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Represents the left margin, in points, of the text frame. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + screenSize?: Word.ScreenSize | "Size544x376" | "Size640x480" | "Size720x512" | "Size800x600" | "Size1024x768" | "Size1152x882" | "Size1152x900" | "Size1280x1024" | "Size1600x1200" | "Size1800x1440" | "Size1920x1200"; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies the target browser for documents viewed in a web browser. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + targetBrowser?: Word.TargetBrowser | "V3" | "V4" | "Ie4" | "Ie5" | "Ie6"; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + useLongFileNames?: boolean; + } + /** An interface describing the data returned by calling `xmlNodeCollection.toJSON()`. */ + interface XmlNodeCollectionData { + items?: Word.Interfaces.XmlNodeData[]; + } + /** An interface describing the data returned by calling `xmlNode.toJSON()`. */ + interface XmlNodeData { /** - * Represents the right margin, in points, of the text frame. + * Gets the name of the element without any prefix. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + baseName?: string; /** - * Represents the top margin, in points, of the text frame. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + hasChildNodes?: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + level?: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - interface ShapeTextWrapData { + namespaceUri?: string; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the type of node. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + nodeType?: Word.XmlNodeType | "Element" | "Attribute"; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + nodeValue?: string; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + placeholderText?: string; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + text?: string; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + validationErrorText?: string; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + validationStatus?: Word.XmlValidationStatus | "Ok" | "Custom"; } - /** An interface describing the data returned by calling `reviewer.toJSON()`. */ - interface ReviewerData { + /** An interface describing the data returned by calling `htmlDivision.toJSON()`. */ + interface HtmlDivisionData { /** - * Specifies if the `Reviewer` object is visible. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ - interface ReviewerCollectionData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ - interface RevisionsFilterData { + leftIndent?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + rightIndent?: number; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ - interface RepeatingSectionItemData { + spaceAfter?: number; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + spaceBefore?: number; } - /** An interface describing the data returned by calling `revision.toJSON()`. */ - interface RevisionData { + /** An interface describing the data returned by calling `htmlDivisionCollection.toJSON()`. */ + interface HtmlDivisionCollectionData { + items?: Word.Interfaces.HtmlDivisionData[]; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + interface FrameData { /** - * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - movedRange?: Word.Interfaces.RangeData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -158097,2347 +166194,2473 @@ declare namespace Word { */ range?: Word.Interfaces.RangeData; /** - * Gets the name of the user who made the tracked change. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - author?: string; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Gets the date and time when the tracked change was made. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - date?: Date; + height?: number; /** - * Gets the description of tracked formatting changes in the revision. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formatDescription?: string; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Gets a number that represents the position of this item in a collection. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + horizontalDistanceFromText?: number; /** - * Gets the revision type. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; - } - /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ - interface RevisionCollectionData { - items?: Word.Interfaces.RevisionData[]; - } - /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ - interface DatePickerContentControlData { + horizontalPosition?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + lockAnchor?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the appearance of the content control. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + textWrap?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + verticalDistanceFromText?: number; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + verticalPosition?: number; /** - * Specifies the format in which dates are displayed. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + width?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ + interface FrameCollectionData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ + interface DocumentLibraryVersionData { /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Gets any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + comments?: string; /** - * Gets the identification for the content control. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + modified?: any; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + modifiedBy?: string; + } + /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ + interface DocumentLibraryVersionCollectionData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface describing the data returned by calling `dropCap.toJSON()`. */ + interface DropCapData { /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + distanceFromText?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the name of the font for the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + fontName?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the height (in lines) of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + linesToDrop?: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Gets the position of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; + } + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + interface ListFormatData { /** - * Specifies a tag to identify the content control. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + list?: Word.Interfaces.ListData; /** - * Specifies the title for the content control. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ - interface PictureContentControlData { + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isSingleList?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isSingleListTemplate?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + listLevelNumber?: number; /** - * Specifies the appearance of the content control. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + listString?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Returns the identification for the content control. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + interface FillFormatData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + gradientAngle?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + gradientDegree?: number; /** - * Specifies a tag to identify the content control. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Specifies the title for the content control. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ - interface GroupContentControlData { + gradientVariant?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isVisible?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Specifies the appearance of the content control. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + rotateWithObject?: boolean; /** - * Returns the identification for the content control. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + textureHorizontalScale?: number; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Returns the name of the custom texture file for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + textureName?: string; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + textureOffsetX?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the vertical offset of the texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + textureOffsetY?: number; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies whether the texture is tiled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + textureTile?: boolean; /** - * Specifies a tag to identify the content control. + * Returns the texture type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies the title for the content control. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ - interface BuildingBlockGalleryContentControlData { + textureVerticalScale?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + transparency?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the fill format type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; + } + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + interface GlowFormatData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + color?: Word.Interfaces.ColorFormatData; /** - * Specifies the appearance of the content control. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + radius?: number; /** - * Specifies the category for the building block content control. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + interface LineFormatData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets the identification for the content control. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies a tag to identify the content control. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the title for the content control. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ - interface RepeatingSectionContentControlData { + insetPen?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + isVisible?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingData; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + transparency?: number; /** - * Specifies the appearance of the content control. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + interface ReflectionFormatData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + blur?: number; /** - * Returns the identification for the content control. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + offset?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + size?: number; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + transparency?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ + interface ColorFormatData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + brightness?: number; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rgb?: string; /** - * Specifies a tag to identify the content control. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + tintAndShade?: number; /** - * Specifies the title for the content control. + * Returns the shape color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + type?: Word.ColorType | "rgb" | "scheme"; } - /** An interface describing the data returned by calling `frame.toJSON()`. */ - interface FrameData { + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + interface ShadowFormatData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + blur?: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + isVisible?: boolean; /** - * Specifies the height (in points) of the frame. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + obscured?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + offsetX?: number; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + offsetY?: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + rotateWithShape?: boolean; /** - * Specifies if the frame is locked. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + size?: number; /** - * Specifies the relative horizontal position of the frame. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies the relative vertical position of the frame. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + transparency?: number; /** - * Specifies if document text wraps around the frame. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ + interface ThreeDimensionalFormatData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the width (in points) of the frame. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + bevelBottomDepth?: number; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ - interface FrameCollectionData { - items?: Word.Interfaces.FrameData[]; - } - /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ - interface DocumentLibraryVersionData { + bevelBottomInset?: number; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: string; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: any; + bevelTopDepth?: number; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: string; - } - /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ - interface DocumentLibraryVersionCollectionData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface describing the data returned by calling `dropCap.toJSON()`. */ - interface DropCapData { + bevelTopInset?: number; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Gets the name of the font for the dropped capital letter. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: string; + contourWidth?: number; /** - * Gets the height (in lines) of the dropped capital letter. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: number; + depth?: number; /** - * Gets the position of the dropped capital letter. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: Word.DropPosition | "None" | "Normal" | "Margin"; - } - /** An interface describing the data returned by calling `listFormat.toJSON()`. */ - interface ListFormatData { + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list?: Word.Interfaces.ListData; + fieldOfView?: number; /** - * Gets the list template associated with the `ListFormat` object. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isPerspective?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + isVisible?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + lightAngle?: number; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - interface FillFormatData { + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Gets the gradient color type. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + projectText?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: number; + rotationX?: number; /** - * Returns the gradient style for the fill. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + rotationY?: number; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: number; + rotationZ?: number; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + interface BibliographyData { /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + sources?: Word.Interfaces.SourceData[]; /** - * Returns the preset gradient type for the fill. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + bibliographyStyle?: string; + } + /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ + interface SourceCollectionData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface describing the data returned by calling `source.toJSON()`. */ + interface SourceData { /** - * Gets the preset texture. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + isCited?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + tag?: string; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Returns the name of the custom texture file for the fill. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: string; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + bookFoldPrinting?: boolean; /** - * Specifies the vertical offset of the texture. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + bookFoldPrintingSheets?: number; /** - * Specifies whether the texture is tiled. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + bookFoldReversePrinting?: boolean; /** - * Returns the texture type for the fill. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + bottomMargin?: number; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + charsLine?: number; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + differentFirstPageHeaderFooter?: boolean; /** - * Gets the fill format type. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - interface GlowFormatData { + footerDistance?: number; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatData; + gutter?: number; /** - * Specifies the length of the radius for a glow effect. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - interface LineFormatData { + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + headerDistance?: number; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + leftMargin?: number; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + linesPage?: number; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + mirrorMargins?: boolean; /** - * Specifies the dash style for the line. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Specifies the style of the arrowhead at the end of the line. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + pageHeight?: number; /** - * Specifies the width of the arrowhead at the end of the line. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + pageWidth?: number; /** - * Specifies if to draw lines inside a shape. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + rightMargin?: number; /** - * Specifies the pattern applied to the line. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies the line format style. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + showGrid?: boolean; /** - * Specifies the thickness of the line in points. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; - } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - interface ReflectionFormatData { + suppressEndnotes?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + topMargin?: number; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + twoPagesOnOne?: boolean; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + interface LineNumberingData { /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + countBy?: number; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ - interface ColorFormatData { + distanceFromText?: number; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: number; + isActive?: boolean; /** - * Specifies the theme color for a color format. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + startingNumber?: number; + } + /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ + interface TextColumnCollectionData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface describing the data returned by calling `textColumn.toJSON()`. */ + interface TextColumnData { /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: number; + spaceAfter?: number; /** - * Returns the shape color type. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ColorType | "rgb" | "scheme"; + width?: number; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - interface ShadowFormatData { + /** An interface describing the data returned by calling `selection.toJSON()`. */ + interface SelectionData { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + end?: number; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + fitTextWidth?: number; /** - * Specifies whether the object or the formatting applied to it is visible. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + hasNoProofing?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + isActive?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + isColumnSelectModeActive?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + isEndOfRowMark?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + isExtendModeActive?: boolean; /** - * Specifies the width of the shadow. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + isInsertionPointAtEndOfLine?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + isStartActive?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + languageDetected?: boolean; /** - * Specifies the shape shadow type. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ - interface ThreeDimensionalFormatData { + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatData; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the depth of the bottom bevel. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: number; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the inset size for the bottom bevel. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + start?: number; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Returns the number of characters in the story that contains the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + storyLength?: number; /** - * Specifies the depth of the top bevel. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the inset size for the top bevel. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + text?: string; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + } + /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ + interface RangeScopedCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + interface BookmarkData { /** - * Specifies the width of the contour of a shape. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies the depth of the shape's extrusion. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + end?: number; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Returns `true` if the bookmark is a table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + isColumn?: boolean; /** - * Specifies the amount of perspective for a shape. + * Returns `true` if the bookmark is empty. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + isEmpty?: boolean; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Returns the name of the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + name?: string; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + start?: number; /** - * Specifies the angle of the lighting. + * Returns the story type for the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + } + /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ + interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + interface IndexData { /** - * Returns a `PresetCamera` value that represents the camera presets. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + range?: Word.Interfaces.RangeData; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Specifies the position of the light source relative to the extrusion. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the intensity of the extrusion lighting. + * Gets the number of columns for each page of the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + numberOfColumns?: number; /** - * Specifies the extrusion surface material. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + rightAlignPageNumbers?: boolean; /** - * Returns the preset extrusion format. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + separateAccentedLetterHeadings?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies the sorting criteria for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Gets the index type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: number; + type?: Word.IndexType | "Indent" | "Runin"; + } + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ + interface ListTemplateCollectionData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ + interface ListTemplateGalleryData { + } + /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ + interface ListTemplateGalleryCollectionData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface EditorLoadOptions { /** - * Specifies the z-axis rotation of the camera. + 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 a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: number; + nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the position on the z-axis for the shape. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - interface BibliographyData { + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sources?: Word.Interfaces.SourceData[]; + id?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: string; - } - /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ - interface SourceCollectionData { - items?: Word.Interfaces.SourceData[]; + name?: boolean; } - /** An interface describing the data returned by calling `source.toJSON()`. */ - interface SourceData { + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ConflictCollectionLoadOptions { /** - * Gets if the `Source` object has been cited in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - isCited?: boolean; + $all?: boolean; /** - * Gets the tag of the source. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; + type?: boolean; } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - interface PageSetupData { + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ConflictLoadOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColumns?: Word.Interfaces.TextColumnData[]; + type?: boolean; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CritiqueAnnotationLoadOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + 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 range of text that is annotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrinting?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the number of pages for each booklet. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrintingSheets?: number; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationLoadOptions { /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldReversePrinting?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bottomMargin?: number; + id?: boolean; /** - * Specifies the number of characters per line in the document grid. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - charsLine?: number; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationCollectionLoadOptions { /** - * Specifies whether the first page has a different header and footer. + 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: Gets the critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - differentFirstPageHeaderFooter?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - footerDistance?: number; + id?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - gutter?: number; + state?: boolean; + } + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ApplicationLoadOptions { /** - * Specifies on which side the gutter appears in a document. + 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; + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + checkLanguage?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: number; + language?: boolean; + } + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface BodyLoadOptions { /** - * Specifies the layout mode for the current document. + 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 text format of the body. Use this to get and set font name, size, color and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - leftMargin?: number; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the number of lines per page in the document grid. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linesPage?: number; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - mirrorMargins?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether odd and even pages have different headers and footers. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - oddAndEvenPagesHeaderFooter?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the orientation of the page. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the page height in points. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageHeight?: number; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the page width in points. + * 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. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageWidth?: number; + style?: boolean; /** - * Specifies the paper size of the page. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + styleBuiltIn?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rightMargin?: number; + text?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + type?: boolean; + } + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderLoadOptions { + /** + 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; /** - * Specifies the type of section break for the specified object. + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + color?: boolean; /** - * Specifies whether to show the grid. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - showGrid?: boolean; + location?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - suppressEndnotes?: boolean; + type?: boolean; /** - * Specifies the top margin of the page in points. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - topMargin?: number; + visible?: boolean; /** - * Specifies whether to print two pages per sheet. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - twoPagesOnOne?: boolean; + width?: boolean; + } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalLoadOptions { /** - * Specifies the vertical alignment of text on each page in a document or section. + 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; + /** + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - interface LineNumberingData { + artStyle?: boolean; /** - * Specifies the numeric increment for line numbers. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: number; + artWidth?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + color?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + colorIndex?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + inside?: boolean; /** - * Specifies the starting line number. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: number; - } - /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ - interface TextColumnCollectionData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface describing the data returned by calling `textColumn.toJSON()`. */ - interface TextColumnData { + isVisible?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: number; + lineStyle?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + lineWidth?: boolean; } - /** An interface describing the data returned by calling `selection.toJSON()`. */ - interface SelectionData { + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderCollectionLoadOptions { /** - * Specifies the ending character position of the selection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - end?: number; + $all?: boolean; /** - * Specifies the width in which Word fits the text in the current selection. + * For EACH ITEM in the collection: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fitTextWidth?: number; + color?: boolean; /** - * Returns whether the spelling and grammar checker ignores the selected text. - If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - hasNoProofing?: boolean; + location?: boolean; /** - * Returns whether the selection in the specified window or pane is active. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isActive?: boolean; + type?: boolean; /** - * Specifies whether column selection mode is active. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isColumnSelectModeActive?: boolean; + visible?: boolean; /** - * Returns whether the selection is at the end-of-row mark in a table. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isEndOfRowMark?: boolean; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalCollectionLoadOptions { /** - * Specifies whether Extend mode is active. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - isExtendModeActive?: boolean; + $all?: boolean; /** - * Returns whether the insertion point is at the end of a line. + * For EACH ITEM in the collection: Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInsertionPointAtEndOfLine?: boolean; + artStyle?: boolean; /** - * Specifies whether the beginning of the selection is active. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isStartActive?: boolean; + artWidth?: boolean; /** - * Specifies whether Word has detected the language of the selected text. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + color?: boolean; /** - * Returns the language for the selection. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + colorIndex?: boolean; /** - * Returns the East Asian language for the selection. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + inside?: boolean; /** - * Returns the language for the selection that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies the orientation of text in the selection. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + lineStyle?: boolean; /** - * Specifies the starting character position of the selection. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakLoadOptions { /** - * Returns the number of characters in the story that contains the selection. + 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; + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the story type for the selection. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakCollectionLoadOptions { /** - * Specifies the text in the selection. + 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: Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the selection type. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; - } - /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ - interface RangeScopedCollectionData { - items?: Word.Interfaces.RangeData[]; + pageIndex?: boolean; } - /** An interface describing the data returned by calling `bookmark.toJSON()`. */ - interface BookmarkData { + /** + * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockLoadOptions { /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - range?: Word.Interfaces.RangeData; + $all?: boolean; /** - * Specifies the ending character position of the bookmark. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Returns `true` if the bookmark is a table column. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isColumn?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Returns `true` if the bookmark is empty. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEmpty?: boolean; + description?: boolean; /** - * Returns the name of the `Bookmark` object. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + id?: boolean; /** - * Specifies the starting character position of the bookmark. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + index?: boolean; /** - * Returns the story type for the bookmark. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - } - /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ - interface BookmarkCollectionData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface describing the data returned by calling `index.toJSON()`. */ - interface IndexData { + insertType?: boolean; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + name?: boolean; /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + value?: boolean; + } + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockCategoryLoadOptions { /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. + * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Gets the number of columns for each page of the index. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + index?: boolean; /** - * Specifies if page numbers are aligned with the right margin in the index. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + name?: boolean; + } + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockTypeItemLoadOptions { /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - separateAccentedLetterHeadings?: boolean; + $all?: boolean; /** - * Specifies the sorting criteria for the index. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + index?: boolean; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CheckboxContentControlLoadOptions { /** - * Gets the index type. + 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; + /** + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ - interface IndexCollectionData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ - interface ListTemplateCollectionData { - items?: Word.Interfaces.ListTemplateData[]; - } - /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ - interface ListTemplateGalleryData { - } - /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ - interface ListTemplateGalleryCollectionData { - items?: Word.Interfaces.ListTemplateGalleryData[]; + isChecked?: boolean; } /** - * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * Represents a coauthoring lock in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface EditorLoadOptions { + interface CoauthoringLockLoadOptions { /** 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 a `Range` object that represents the next range that the editor has permissions to modify. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextRange?: Word.Interfaces.RangeLoadOptions; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -160445,36 +168668,36 @@ declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - id?: boolean; - /** - * Gets the name of the editor. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + type?: boolean; } /** - * Represents the coauthoring conflicts in a Word document. + * Represents a collection of coauthoring locks in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ConflictCollectionLoadOptions { + interface CoauthoringLockCollectionLoadOptions { /** 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: Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * For EACH ITEM in the collection: Gets the owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owner?: Word.Interfaces.CoauthorLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -160482,7 +168705,7 @@ declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. + * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -160491,749 +168714,822 @@ declare namespace Word { type?: boolean; } /** - * Represents a coauthoring conflict in a Word document. + * Represents a coauthor in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ConflictLoadOptions { + interface CoauthorLoadOptions { /** 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + emailAddress?: boolean; /** - * Gets the `RevisionType` for the `Conflict` object. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents an annotation wrapper around critique displayed in the document. - * - * @remarks - * [Api set: WordApi 1.7] - */ - 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; + id?: boolean; /** - * Gets the range of text that is annotated. + * Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + isMe?: boolean; /** - * Gets the critique that was passed when the annotation was inserted. + * Gets the display name of the coauthor. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: boolean; + name?: boolean; } /** - * Represents an annotation attached to a paragraph. + * Contains a collection of {@link Word.Coauthor} objects. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface AnnotationLoadOptions { + interface CoauthorCollectionLoadOptions { /** 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. + * For EACH ITEM in the collection: Gets the email address of the coauthor. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + emailAddress?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ id?: boolean; /** - * Gets the state of the annotation. + * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; + isMe?: boolean; + /** + * For EACH ITEM in the collection: Gets the display name of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; } /** - * Contains a collection of {@link Word.Annotation} objects. + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface AnnotationCollectionLoadOptions { + interface CoauthoringLoadOptions { /** 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; + $all?: boolean; + /** + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + me?: Word.Interfaces.CoauthorLoadOptions; /** - * For EACH ITEM in the collection: Gets the critique annotation object. + * Gets whether this document can be coauthored. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + canCoauthor?: boolean; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Gets whether the document can be automatically merged. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + canMerge?: boolean; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Gets whether the document has pending updates that have not been accepted. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; + pendingUpdates?: boolean; } /** - * Represents the application object. + * Represents a coauthoring update in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ApplicationLoadOptions { + interface CoauthoringUpdateLoadOptions { /** 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; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringUpdateCollectionLoadOptions { /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - checkLanguage?: boolean; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: boolean; + range?: Word.Interfaces.RangeLoadOptions; } /** - * Represents the body of a document or a section. + * Represents a comment in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - interface BodyLoadOptions { + interface CommentLoadOptions { /** 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 text format of the body. Use this to get and set font name, size, color and other properties. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * 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. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + authorEmail?: boolean; /** - * 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}. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + authorName?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + content?: boolean; /** - * 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}. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + creationDate?: boolean; /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentSection?: Word.Interfaces.SectionLoadOptions; + id?: boolean; /** - * 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}. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + resolved?: boolean; + } + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentCollectionLoadOptions { /** - * 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. + 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: Specifies the comment's content range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - style?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets the email of the comment's author. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - styleBuiltIn?: boolean; + authorEmail?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - text?: boolean; + authorName?: boolean; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * For EACH ITEM in the collection: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - type?: boolean; + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; + /** + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. - * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - interface BorderLoadOptions { + interface CommentContentRangeLoadOptions { /** 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; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + bold?: boolean; /** - * Gets the location of the border. + * 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. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - location?: boolean; + hyperlink?: boolean; /** - * Specifies the border type for the border. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - type?: boolean; + isEmpty?: boolean; /** - * Specifies whether the border is visible. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - visible?: boolean; + italic?: boolean; /** - * Specifies the width for the border. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - width?: boolean; + strikeThrough?: boolean; + /** + * Gets the text of the comment range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + text?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: boolean; } /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * Represents a comment reply in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface BorderUniversalLoadOptions { + interface CommentReplyLoadOptions { /** 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; /** - * Specifies the graphical page-border design for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - artStyle?: boolean; - /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - artWidth?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: boolean; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - colorIndex?: boolean; + authorEmail?: boolean; /** - * Returns `true` if an inside border can be applied to the specified object. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - inside?: boolean; + authorName?: boolean; /** - * Specifies whether the border is visible. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isVisible?: boolean; + content?: boolean; /** - * Specifies the line style of the border. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lineStyle?: boolean; + creationDate?: boolean; /** - * Specifies the line width of an object's border. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lineWidth?: boolean; + id?: boolean; } /** - * Represents the collection of border styles. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - interface BorderCollectionLoadOptions { + interface CommentReplyCollectionLoadOptions { /** 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: Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * For EACH ITEM in the collection: Specifies the commentReply's content range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the location of the border. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - location?: boolean; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * For EACH ITEM in the collection: Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - type?: boolean; + authorEmail?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - visible?: boolean; + authorName?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - width?: boolean; + content?: boolean; + /** + * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; } /** - * Represents the collection of {@link Word.BorderUniversal} objects. + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BorderUniversalCollectionLoadOptions { + interface ConditionalStyleLoadOptions { /** 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: Specifies the graphical page-border design for the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - artStyle?: boolean; - /** - * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + bottomPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + leftPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + rightPadding?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; + topPadding?: boolean; } /** - * Represents a break in a Word document. + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BreakLoadOptions { + interface XmlMappingLoadOptions { /** 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; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns the page number on which the break occurs. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; - } - /** - * Contains a collection of {@link Word.Break} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BreakCollectionLoadOptions { + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - 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`). + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isMapped?: boolean; /** - * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + prefixMappings?: boolean; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; + xpath?: boolean; } /** - * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BuildingBlockLoadOptions { + interface CustomXmlPrefixMappingCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + namespaceUri?: boolean; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingLoadOptions { /** - * Specifies the description for the building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - description?: boolean; + $all?: boolean; /** - * Returns the internal identification number for the building block. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + namespaceUri?: boolean; /** - * Returns the position of this building block in a collection. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + prefix?: boolean; + } + /** + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlSchemaLoadOptions { /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - insertType?: boolean; + $all?: boolean; /** - * Specifies the name of the building block. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + location?: boolean; /** - * Specifies the contents of the building block. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: boolean; + namespaceUri?: boolean; } /** - * Represents a category of building blocks in a Word document. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BuildingBlockCategoryLoadOptions { + interface CustomXmlSchemaCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; - /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + location?: boolean; /** - * Returns the name of the `BuildingBlockCategory` object. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + namespaceUri?: boolean; } /** - * Represents a type of building block in a Word document. + * Represents a collection of {@link Word.CustomXmlValidationError} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BuildingBlockTypeItemLoadOptions { + interface CustomXmlValidationErrorCollectionLoadOptions { /** 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; /** - * Returns the position of an item in a collection. + * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns the localized name of a building block type. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + errorCode?: boolean; + /** + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CheckboxContentControlLoadOptions { /** - 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`). + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + text?: boolean; /** - * Specifies the current state of the checkbox. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; + type?: boolean; } /** - * Represents a coauthoring lock in a Word document. + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CoauthoringLockLoadOptions { + interface CustomXmlValidationErrorLoadOptions { /** 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 owner of the lock. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist. If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorLoadOptions; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + errorCode?: boolean; /** - * Gets a `CoauthoringLockType` value that represents the lock type. + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * Gets the text in the `CustomXmlValidationError` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: boolean; + /** + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -161242,976 +169538,856 @@ declare namespace Word { type?: boolean; } /** - * Represents a collection of coauthoring locks in a Word document. + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CoauthoringLockCollectionLoadOptions { + interface CustomXmlNodeCollectionLoadOptions { /** 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: Gets the owner of the lock. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - owner?: Word.Interfaces.CoauthorLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents a coauthor in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CoauthorLoadOptions { + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - 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`). + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the email address of the coauthor. + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the unique identifier for the `Coauthor` object. + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether this author represents the current user. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + baseName?: boolean; /** - * Gets the display name of the coauthor. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * Contains a collection of {@link Word.Coauthor} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CoauthorCollectionLoadOptions { + namespaceUri?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets the type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * For EACH ITEM in the collection: Gets the email address of the coauthor. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailAddress?: boolean; + nodeValue?: boolean; /** - * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets whether this author represents the current user. + * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMe?: boolean; + xpath?: boolean; /** - * For EACH ITEM in the collection: Gets the display name of the coauthor. + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + xml?: boolean; } /** - * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface CoauthoringLoadOptions { + interface CustomXmlNodeLoadOptions { /** 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 a `Coauthor` object that represents the current user. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - me?: Word.Interfaces.CoauthorLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether this document can be coauthored. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canCoauthor?: boolean; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether the document can be automatically merged. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canMerge?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets whether the document has pending updates that have not been accepted. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pendingUpdates?: boolean; - } - /** - * Represents a coauthoring update in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CoauthoringUpdateLoadOptions { - /** - 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; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; - } - /** - * Contains a collection of {@link Word.CoauthoringUpdate} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CoauthoringUpdateCollectionLoadOptions { - /** - 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; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; - } - /** - * Represents a comment in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentLoadOptions { - /** - 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; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the comment's content range. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + baseName?: boolean; /** - * Gets the email of the comment's author. + * Gets the unique address identifier for the namespace of the node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: boolean; + namespaceUri?: boolean; /** - * Gets the name of the comment's author. + * Gets the type of the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: boolean; + nodeType?: boolean; /** - * Specifies the comment's content as plain text. + * Specifies the value of the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + nodeValue?: boolean; /** - * Gets the creation date of the comment. + * Specifies the text for the current node. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + text?: boolean; /** - * Gets the ID of the comment. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + xpath?: boolean; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Gets the XML representation of the current node and its children. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; + xml?: boolean; } /** - * Contains a collection of {@link Word.Comment} objects. + * 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.4] + * [Api set: WordApi 1.1] */ - interface CommentCollectionLoadOptions { + interface ContentControlLoadOptions { /** 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: Specifies the comment's content range. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] */ - authorEmail?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * 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.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - id?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * 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.4] - */ - resolved?: boolean; - } - /** - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentContentRangeLoadOptions { - /** - 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`). + * [Api set: WordApi 1.1] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a value that indicates whether the comment text is bold. + * 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.4] + * [Api set: WordApi 1.3] */ - bold?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * 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. + * 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.4] + * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Checks whether the range length is zero. + * 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.4] + * [Api set: WordApi 1.3] */ - isEmpty?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a value that indicates whether the comment text is italicized. + * 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.4] + * [Api set: WordApi 1.3] */ - italic?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * 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.4] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the text of the comment range. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] - */ - underline?: boolean; - } - /** - * Represents a comment reply in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentReplyLoadOptions { - /** - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Specifies the commentReply's content range. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the parent comment of this reply. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + appearance?: boolean; /** - * Gets the email of the comment reply's author. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + cannotDelete?: boolean; /** - * Gets the name of the comment reply's author. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + cannotEdit?: boolean; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + color?: boolean; /** - * Gets the creation date of the comment reply. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + id?: boolean; /** - * Gets the ID of the comment reply. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; - } - /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentReplyCollectionLoadOptions { + placeholderText?: boolean; /** - 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`). + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + removeWhenEdited?: boolean; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * Specifies the style name for the content control. 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. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + subtype?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + title?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; + type?: boolean; } /** - * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface ConditionalStyleLoadOptions { + interface ContentControlCollectionLoadOptions { /** 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; /** - * Returns a `Font` object that represents the font formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; - /** - * Returns a `ShadingUniversal` object that represents the shading of the conditional style. + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bottomPadding?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftPadding?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rightPadding?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topPadding?: boolean; - } - /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface XmlMappingLoadOptions { + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - 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`). + * For EACH ITEM in the collection: Gets the parent body of the content control. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * 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 BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingCollectionLoadOptions { + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - 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`). + * 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] */ - $all?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefix?: boolean; - } - /** - * Represents a `CustomXmlPrefixMapping` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingLoadOptions { - /** - 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; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; - } - /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlSchemaLoadOptions { + appearance?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + cannotDelete?: boolean; /** - * Gets the location of the schema on a computer. + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - location?: boolean; + cannotEdit?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlSchemaCollectionLoadOptions { + color?: boolean; /** - 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`). + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - location?: boolean; + placeholderText?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlValidationErrorCollectionLoadOptions { + removeWhenEdited?: boolean; /** - 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`). + * For EACH ITEM in the collection: Specifies the style name for the content control. 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. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - errorCode?: boolean; + subtype?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - name?: boolean; + tag?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ text?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + */ + title?: boolean; + /** + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * + * @remarks + * [Api set: WordApi 1.1] */ type?: boolean; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Represents a list item in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - interface CustomXmlValidationErrorLoadOptions { + interface ContentControlListItemLoadOptions { /** 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 node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + displayText?: boolean; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - errorCode?: boolean; + index?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - name?: boolean; + value?: boolean; + } + /** + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + interface ContentControlListItemCollectionLoadOptions { /** - * Gets the text in the `CustomXmlValidationError` object. + 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: Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - text?: boolean; + displayText?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - type?: boolean; + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Represents a custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface CustomXmlNodeCollectionLoadOptions { + interface CustomPropertyLoadOptions { /** 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: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + key?: boolean; /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + value?: boolean; + } + /** + * Contains the collection of {@link Word.CustomProperty} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface CustomPropertyCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - baseName?: boolean; + value?: boolean; + } + /** + * Represents a custom XML part. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartLoadOptions { /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -162220,115 +170396,98 @@ declare namespace Word { xml?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * Contains the collection of {@link Word.CustomXmlPart} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface CustomXmlNodeLoadOptions { + interface CustomXmlPartCollectionLoadOptions { /** 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 a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + builtIn?: boolean; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + id?: boolean; /** - * Gets the object representing the part associated with this node. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + namespaceUri?: boolean; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartScopedCollectionLoadOptions { /** - * Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + 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`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * Gets the type of the current node. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Specifies the value of the current node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * Specifies the text for the current node. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -162337,855 +170496,883 @@ declare namespace Word { xml?: 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, checkbox, dropdown list, and combo box content controls are supported. + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. * * @remarks * [Api set: WordApi 1.1] */ - interface ContentControlLoadOptions { + interface DocumentLoadOptions { /** 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 building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowLoadOptions; + /** + * Specifies a `Template` object that represents the template attached to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets a `Shape` object that represents the background image for the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + background?: Word.Interfaces.ShapeLoadOptions; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * 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] */ - font?: Word.Interfaces.FontLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets a `DocumentProperties` object that represents all the built-in document properties for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; - /** - * Gets the parent body of the content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; + builtInDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** - * 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}. + * Gets a `Range` object that represents the main document story. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + content?: Word.Interfaces.RangeLoadOptions; /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets a `DocumentProperties` collection that represents all the custom document properties for the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + customDocumentProperties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Returns a `PageSetup` object that's associated with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * 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}. + * Gets the properties of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * 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}. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + selection?: Word.Interfaces.SelectionLoadOptions; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the `WebSettings` object for webpage-related attributes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + webSettings?: Word.Interfaces.WebSettingsLoadOptions; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Gets the name of the active theme and formatting options. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + activeTheme?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the display name of the active theme. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + activeThemeDisplayName?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets whether Word encrypts file properties for password-protected documents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: boolean; + areFilePropertiesPasswordEncrypted?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether grammatical errors are marked by a wavy green line in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + areGrammaticalErrorsShown?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether to use the default math settings when creating new equations. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + areMathDefaultsUsed?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies whether to disable features introduced after a specified version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + areNewerFeaturesDisabled?: boolean; /** - * Gets an integer that represents the content control identifier. + * Specifies whether Microsoft Word underlines spelling errors in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + areSpellingErrorsShown?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether the styles in this document are updated to match the styles in the attached template each time the document is opened. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: boolean; + areStylesUpdatedOnOpen?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether Microsoft Word embeds TrueType fonts in the document when it's saved. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + areTrueTypeFontsEmbedded?: boolean; /** - * Specifies the style name for the content control. 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. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + autoHyphenation?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies if the edits in the document are automatically saved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + autoSaveOn?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - subtype?: boolean; + changeTrackingMode?: boolean; /** - * Specifies a tag to identify a content control. + * Gets the code name for the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: boolean; + codeName?: boolean; /** - * Gets the text of the content control. + * Gets the compatibility mode that Word uses when opening the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + compatibilityMode?: boolean; /** - * Specifies the title for a content control. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + consecutiveHyphensLimit?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets a random number that Word assigns to changes in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface ContentControlCollectionLoadOptions { + currentRsid?: boolean; /** - 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`). + * Specifies the interval (in points) between the default tab stops in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + defaultTabStop?: boolean; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the browser frame for displaying a webpage via hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + defaultTargetFrame?: boolean; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies whether Word should not embed common system fonts. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + doNotEmbedSystemFonts?: boolean; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies the name of the algorithm encryption provider that Microsoft Word uses when encrypting documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + encryptionProvider?: boolean; /** - * 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. + * Specifies the East Asian language used for line breaking. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + farEastLineBreakLanguage?: boolean; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies the line break control level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + farEastLineBreakLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Specifies whether Word shows the next heading level when the previous is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + formattingIsNextLevelShown?: boolean; /** - * 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. + * Specifies whether to show user-defined styles. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + formattingIsUserStyleNameShown?: boolean; /** - * 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}. + * Gets the name of a document, including the path. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + fullName?: boolean; /** - * 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. + * Specifies the horizontal space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + gridDistanceHorizontal?: boolean; /** - * 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. + * Specifies the vertical space between invisible gridlines that Microsoft Word uses when you draw, move, and resize AutoShapes or East Asian characters in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + gridDistanceVertical?: boolean; /** - * 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}. + * Specifies whether the character grid starts from the upper-left corner of the page. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + gridIsOriginFromMargin?: boolean; /** - * 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}. + * Specifies the horizontal origin point for the invisible grid. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + gridOriginHorizontal?: boolean; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies the vertical origin point for the invisible grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + gridOriginVertical?: boolean; /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the interval for horizontal character gridlines in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + gridSpaceBetweenHorizontalLines?: boolean; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the interval for vertical character gridlines in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + gridSpaceBetweenVerticalLines?: boolean; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets whether a password is required to open the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: boolean; + hasPassword?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Gets whether the document has an attached Microsoft Visual Basic for Applications project. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + hasVbProject?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + hyphenateCaps?: boolean; /** - * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the width of the hyphenation zone, in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + hyphenationZone?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * Specifies whether automatic formatting options override formatting restrictions. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + isAutoFormatOverrideOn?: boolean; /** - * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether charts in the active document use cell-reference data-point tracking. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: boolean; + isChartDataPointTracked?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether the compatibility option specified by the `type` property is enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + isCompatible?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the content control. 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. + * Specifies whether the document is final. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isFinal?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether Microsoft Word saves a subset of the embedded TrueType fonts with the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + isFontsSubsetSaved?: boolean; /** - * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies whether Microsoft Word prints onto a preprinted form only the data entered in the corresponding online form. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: boolean; + isFormsDataPrinted?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * Specifies whether Microsoft Word saves the data entered in a form as a tab-delimited record for use in a database. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: boolean; + isFormsDataSaved?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * Specifies whether a grammar check has been run on the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + isGrammarChecked?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * Gets whether the most recent firing of the `Application.DocumentBeforeSave` event was the result of an automatic save by the document or a manual save by the user. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + isInAutoSave?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets whether the document is in form design mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Represents a list item in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - interface ContentControlListItemLoadOptions { + isInFormsDesign?: boolean; /** - 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`). + * Specifies whether Word kerns half-width Latin characters and punctuation marks. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isKerningByAlgorithm?: boolean; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies whether to embed speech and handwriting data. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + isLinguisticDataEmbedded?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * Gets whether this document is a master document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + isMasterDocument?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies whether Word optimizes the document for Word 97. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - interface ContentControlListItemCollectionLoadOptions { + isOptimizedForWord97?: boolean; /** - 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`). + * Specifies whether {@link https://support.microsoft.com/office/0250c02b-060f-4986-88a4-36cec2a9665f | PRINT field} instructions (such as PostScript commands) in the document are to be printed on top of text and graphics when a PostScript printer is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isPostScriptPrintedOverText?: boolean; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies whether users can change the Quick Style set. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + isQuickStyleSetLocked?: boolean; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Gets whether changes to the document cannot be saved to the original document. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + isReadOnly?: boolean; /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies whether Microsoft Word displays a message box whenever a user opens the document, suggesting that it be opened as read-only. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyLoadOptions { + isReadOnlyRecommended?: boolean; /** - 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`). + * Specifies whether AutoShapes or East Asian characters are automatically aligned with an invisible grid. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSnappedToGrid?: boolean; /** - * Gets the key of the custom property. + * Specifies whether AutoShapes or East Asian characters align with invisible gridlines through other shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + isSnappedToShapes?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether spelling has been checked throughout the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + isSpellingChecked?: boolean; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies whether formatting restrictions are enforced in a protected document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.CustomProperty} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyCollectionLoadOptions { + isStyleEnforced?: boolean; /** - 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`). + * Gets whether this document is a subdocument of a master document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isSubdocument?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * Specifies whether users can change the document theme. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + isThemeLocked?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether the document was created or opened by the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + isUserControl?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Gets whether the VBA project is digitally signed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartLoadOptions { + isVbaSigned?: boolean; /** - 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`). + * Gets whether the document is protected with a write password. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isWriteReserved?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the character spacing adjustment. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + justificationMode?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the format type that Microsoft Word uses when automatically formatting the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + kind?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + languageDetected?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies the kinsoku characters after which Word will not break a line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + noLineBreakAfter?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the kinsoku characters before which Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartCollectionLoadOptions { + noLineBreakBefore?: boolean; /** - 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`). + * Gets the encoding used to open the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + openEncoding?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Gets the title of the original document after legal-blackline comparison. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + originalDocumentTitle?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Sets a password that must be supplied to open the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + password?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Gets the algorithm used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + passwordEncryptionAlgorithm?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Gets the key length used for password encryption. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + passwordEncryptionKeyLength?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Gets the name of the password encryption provider. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartScopedCollectionLoadOptions { + passwordEncryptionProvider?: boolean; /** - 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`). + * Gets the disk or the web path to the document (excludes the document name). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + path?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether revision marks are printed with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + printRevisions?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Gets the protection type for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + protectionType?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the width of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + readingLayoutSizeX?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies the height of pages in reading layout view when frozen. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + readingLayoutSizeY?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies whether pages in reading layout view are frozen for handwritten markup. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface DocumentLoadOptions { + readingModeIsLayoutFrozen?: boolean; /** - 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`). + * Specifies whether Word removes user information upon saving. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + removePersonalInformationOnSave?: boolean; /** - * Gets the active window for the document. + * Gets the title of the revised document after legal-blackline comparison. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowLoadOptions; + revisedDocumentTitle?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies the encoding used when saving the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + saveEncoding?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Gets the file format of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + saveFormat?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * 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. * * @remarks * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + saved?: boolean; /** - * Gets a `Coauthoring` object for managing coauthoring in the document. + * Specifies the encoding for saving as encoded text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coauthoring?: Word.Interfaces.CoauthoringLoadOptions; + textEncoding?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies how Word marks line and paragraph breaks in text files. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + textLineEnding?: boolean; /** - * Gets the properties of the document. + * Specifies whether to track formatting changes when change tracking is on. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + trackFormatting?: boolean; /** - * Returns a `Selection` object that represents the current selection in the document. + * Specifies whether to mark moved text when Track Changes is on. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection?: Word.Interfaces.SelectionLoadOptions; + trackMoves?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies whether changes are tracked in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + trackRevisions?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies whether to remove or store date and time metadata for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + trackedChangesAreDateAndTimeRemoved?: boolean; /** - * Specifies the ChangeTracking mode. + * Gets the document type (template or document). * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: boolean; + type?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Sets a password for saving changes to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: boolean; + writePassword?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies whether error messages are generated from built-in Word messages or MSXML (Microsoft XML). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + xmlAreAdvancedErrorsShown?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies whether to save a document through an Extensible Stylesheet Language Transformation (XSLT). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + xmlIsXsltUsedWhenSaving?: boolean; /** - * 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. + * Specifies the path and file name for the XSLT to apply when saving a document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + xmlSaveThroughXSLT?: boolean; } /** * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. @@ -165025,7 +173212,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - progID?: boolean; + progId?: boolean; } /** * Represents a page in the document. `Page` objects manage the page layout and content. @@ -171434,504 +179621,1057 @@ declare namespace Word { title?: boolean; } /** - * Represents the `PictureContentControl` object. + * Represents the `PictureContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface PictureContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `GroupContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface GroupContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `BuildingBlockGalleryContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockGalleryContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the category for the building block content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockCategory?: boolean; + /** + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockType?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Gets if the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `RepeatingSectionContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface RepeatingSectionContentControlLoadOptions { + /** + 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; + /** + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allowInsertDeleteSection?: boolean; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionItemTitle?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents one of the readability statistics for the document or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface PictureContentControlLoadOptions { + interface ReadabilityStatisticLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns the name of the readability statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + name?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Returns the value of the grammar statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + value?: boolean; + } + /** + * Represents a collection of {@link Word.ReadabilityStatistic} objects for the document or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ReadabilityStatisticCollectionLoadOptions { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + 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: Returns the name of the readability statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + name?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Returns the value of the grammar statistic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + value?: boolean; + } + /** + * Represents the settings for saving a Word document as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WebSettingsLoadOptions { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + 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; + /** + * Specifies whether PNG is allowed as an image format when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + allowPng?: boolean; /** - * Returns the identification for the content control. + * Specifies the document encoding (code page or character set) to be used by the web browser when viewing the saved document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + encoding?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the folder suffix used when saving a document as a webpage with long file names and supporting files in a separate folder. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + folderSuffix?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies whether supporting files are organized in a separate folder when saving the document as a webpage. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + organizeInFolder?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the density (pixels per inch) of graphics images and table cells on a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + pixelsPerInch?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether cascading style sheets (CSS) are used for font formatting when viewing a saved document in a web browser. Default is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + relyOnCSS?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies whether image files are not generated from drawing objects when saving a document as a webpage. Default is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + relyOnVectorMarkupLanguage?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the ideal minimum screen size (width by height, in pixels) for viewing the saved document in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + screenSize?: boolean; /** - * Specifies the title for the content control. + * Specifies the target browser for documents viewed in a web browser. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + targetBrowser?: boolean; + /** + * Specifies whether long file names are used when saving the document as a webpage. Default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useLongFileNames?: boolean; } /** - * Represents the `GroupContentControl` object. + * Represents the collection of {@link Word.XmlNode} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface GroupContentControlLoadOptions { + interface XmlNodeCollectionLoadOptions { /** 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; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * For EACH ITEM in the collection: Gets the first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets the parent document of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the parent element of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Returns the identification for the content control. + * For EACH ITEM in the collection: Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * For EACH ITEM in the collection: Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * For EACH ITEM in the collection: Gets the name of the element without any prefix. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + baseName?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * For EACH ITEM in the collection: Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + hasChildNodes?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * For EACH ITEM in the collection: Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + level?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + namespaceUri?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Gets the type of node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + nodeType?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; - } - /** - * Represents the `BuildingBlockGalleryContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BuildingBlockGalleryContentControlLoadOptions { - /** - 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; + nodeValue?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * For EACH ITEM in the collection: Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + placeholderText?: boolean; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + text?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + validationErrorText?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + validationStatus?: boolean; + } + /** + * Represents a single XML node applied to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface XmlNodeLoadOptions { /** - * Specifies the category for the building block content control. + 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 first child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: boolean; + firstChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets the last child node if this is a parent node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: boolean; + lastChild?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the next element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + nextSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the identification for the content control. + * Gets the parent document of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + ownerDocument?: Word.Interfaces.DocumentLoadOptions; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the parent element of this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + parentNode?: Word.Interfaces.XmlNodeLoadOptions; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the previous element in the document that's at the same level as this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + previousSibling?: Word.Interfaces.XmlNodeLoadOptions; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the portion of a document that is contained in this XML node. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the name of the element without any prefix. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + baseName?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * Gets whether this XML node has child nodes. Always returns `false` for attribute nodes since they cannot have children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + hasChildNodes?: boolean; /** - * Specifies a tag to identify the content control. + * Gets whether this XML element is part of a paragraph, is a paragraph, or is contained within a table cell or contains a table row. Returns `null` if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + level?: boolean; /** - * Specifies the title for the content control. + * Gets the Uniform Resource Identifier (URI) of the schema namespace for this XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; - } - /** - * Represents the `RepeatingSectionContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface RepeatingSectionContentControlLoadOptions { + namespaceUri?: boolean; /** - 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`). + * Gets the type of node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the value of this XML node. For element nodes, represents the text content; for attribute nodes, represents the attribute value. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + nodeValue?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the text displayed for this element if it contains no text. Only applies to element nodes, not attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + placeholderText?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the text contained within the XML element. Returns an empty string if the node type is `attribute`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + text?: boolean; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Gets the description for a validation error on this `XmlNode` object. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + validationErrorText?: boolean; /** - * Specifies the appearance of the content control. + * Gets whether this element is valid according to the attached schema. May not be meaningful for attribute nodes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + validationStatus?: boolean; + } + /** + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HtmlDivisionLoadOptions { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + 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 a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the identification for the content control. + * Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + leftIndent?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + rightIndent?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + spaceAfter?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + spaceBefore?: boolean; + } + /** + * Represents a collection of {@link Word.HtmlDivision} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HtmlDivisionCollectionLoadOptions { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + 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: Gets a `Range` object that represents the portion of a document that's contained in this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * For EACH ITEM in the collection: Specifies the left indent value (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: boolean; + leftIndent?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Specifies the right indent (in points) for this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rightIndent?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + spaceAfter?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the spacing (in points) before this HTML division. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + spaceBefore?: boolean; } /** * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. @@ -172315,20 +181055,20 @@ declare namespace Word { */ $all?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ list?: Word.Interfaces.ListLoadOptions; /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** * Indicates whether the `ListFormat` object contains a single list. @@ -173858,7 +182598,6 @@ declare namespace Word { * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta */ listFormat?: Word.Interfaces.ListFormatLoadOptions; /** @@ -173915,7 +182654,6 @@ declare namespace Word { * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta */ shading?: Word.Interfaces.ShadingUniversalLoadOptions; /**